Module: features/feature

Enumerations

Type aliases

CoercableComponent

Ƭ CoercableComponent: string | DefineComponent | JSXFunction

Defined in

profectus/src/features/feature.ts:10


FeatureComponent

Ƭ FeatureComponent<T>: Omit<{ [K in keyof T]: T[K] extends ProcessedComputable<infer S> ? S : T[K] }, typeof Component | typeof DefaultValue>

Type parameters

Name
T

Defined in

profectus/src/features/feature.ts:18


GenericComponent

Ƭ GenericComponent: DefineComponent<any, any, any>

Defined in

profectus/src/features/feature.ts:16


JSXFunction

Ƭ JSXFunction: () => JSX.Element & { [DoNotCache]: true }

Defined in

profectus/src/features/feature.ts:9


Replace

Ƭ Replace<T, S>: S & Omit<T, keyof S>

Type parameters

Name
T
S

Defined in

profectus/src/features/feature.ts:25


StyleValue

Ƭ StyleValue: string | CSSProperties | (string | CSSProperties)[]

Defined in

profectus/src/features/feature.ts:11

Variables

Component

Const Component: typeof Component

Defined in

profectus/src/features/feature.ts:6


GatherProps

Const GatherProps: typeof GatherProps

Defined in

profectus/src/features/feature.ts:7

Functions

findFeatures

findFeatures(obj, type): unknown[]

Parameters

NameType
objRecord<string, unknown>
typesymbol

Returns

unknown[]

Defined in

profectus/src/features/feature.ts:61


getUniqueID

getUniqueID(prefix?): string

Parameters

NameTypeDefault value
prefixstring"feature-"

Returns

string

Defined in

profectus/src/features/feature.ts:32


jsx

jsx(func): JSXFunction

Parameters

NameType
func() => "" | Element

Returns

JSXFunction

Defined in

profectus/src/features/feature.ts:42


setDefault

setDefault<T, K>(object, key, value): asserts object is Exclude<T, K> & Required<Pick<T, K>>

Type parameters

NameType
TT
Kextends string | number | symbol

Parameters

NameType
objectT
keyK
valueT[K]

Returns

asserts object is Exclude<T, K> & Required<Pick<T, K>>

Defined in

profectus/src/features/feature.ts:51


showIf

showIf(condition, otherwise?): Visibility

Parameters

NameTypeDefault value
conditionbooleanundefined
otherwiseVisibilityVisibility.None

Returns

Visibility

Defined in

profectus/src/features/feature.ts:47