Toolkit

Appearance

Documentation / @andrew_l/app / PropOptions

Interface: PropOptions<T> ​

Declaration for a single typed app prop.

Type Parameters ​

T ​

T = any

Properties ​

alias? ​

optional alias: string

default()? ​

optional default: () => InferPropType<T>

Returns ​

InferPropType<T>

description? ​

optional description: string

enum? ​

optional enum: string[]

env? ​

optional env: string | string[]

parser()? ​

optional parser: (value) => InferPropType<T>

Parameters ​

value ​

string

Returns ​

InferPropType<T>

required? ​

optional required: boolean

type ​

type: null | PropType<T>