-
Notifications
You must be signed in to change notification settings - Fork 0
stringdictionary
runtypes / Exports / StringDictionary
| Name | Type |
|---|---|
V |
Runtype |
• Readonly _falseWitness: object
Inherited from: Runtype._falseWitness
Defined in: src/runtype.ts:39
• key: string
Defined in: src/types/dictionary.ts:29
• Readonly reflect: Reflect
Convert this to a Reflect, capable of introspecting the structure of the type.
Inherited from: Runtype.reflect
Defined in: src/runtype.ts:37
• tag: dictionary
Defined in: src/types/dictionary.ts:28
• value: V
Defined in: src/types/dictionary.ts:30
▸ And<B>(B: B): Intersect<[StringDictionary<V>, B]>
Intersect this Runtype with another.
| Name | Type |
|---|---|
B |
Runtype<unknown, B> |
| Name | Type |
|---|---|
B |
B |
Returns: Intersect<[StringDictionary<V>, B]>
Inherited from: Runtype
Defined in: src/runtype.ts:54
▸ Or<B>(B: B): Union<[StringDictionary<V>, B]>
Union this Runtype with another.
| Name | Type |
|---|---|
B |
Runtype<unknown, B> |
| Name | Type |
|---|---|
B |
B |
Returns: Union<[StringDictionary<V>, B]>
Inherited from: Runtype
Defined in: src/runtype.ts:49
▸ assert(x: any): asserts x is object
Verifies that a value conforms to this runtype. When given a value that does not conform to the runtype, throws an exception.
| Name | Type |
|---|---|
x |
any |
Returns: asserts x is object
Inherited from: Runtype
Defined in: src/runtype.ts:15
▸ check(x: any): object
Verifies that a value conforms to this runtype. If so, returns the same value, statically typed. Otherwise throws an exception.
| Name | Type |
|---|---|
x |
any |
Returns: object
Inherited from: Runtype
Defined in: src/runtype.ts:21
▸ guard(x: any): x is object
A type guard for this runtype.
| Name | Type |
|---|---|
x |
any |
Returns: x is object
Inherited from: Runtype
Defined in: src/runtype.ts:32
▸ optional(): Optional<StringDictionary<V>>
Optionalize this Runtype.
Returns: Optional<StringDictionary<V>>
Inherited from: Runtype
Defined in: src/runtype.ts:59
▸ validate(x: any): Result<{ [_: string]: Static<V>; }>
Validates that a value conforms to this type, and returns a result indicating success or failure (does not throw).
| Name | Type |
|---|---|
x |
any |
Returns: Result<{ [_: string]: Static<V>; }>
Inherited from: Runtype
Defined in: src/runtype.ts:27
▸ withBrand<B>(brand: B): Brand<B, StringDictionary<V>>
Adds a brand to the type.
| Name | Type |
|---|---|
B |
string |
| Name | Type |
|---|---|
brand |
B |
Returns: Brand<B, StringDictionary<V>>
Inherited from: Runtype
Defined in: src/runtype.ts:102
▸ withConstraint<T, K>(constraint: ConstraintCheck<StringDictionary<V>>, options?: { args?: K ; name?: string }): Constraint<StringDictionary<V>, T, K>
Use an arbitrary constraint function to validate a runtype, and optionally to change its name and/or its static type.
| Name | Type | Default | Description |
|---|---|---|---|
T |
object | - | Optionally override the static type of the resulting runtype |
K |
- | unknown | - |
| Name | Type | Description |
|---|---|---|
constraint |
ConstraintCheck<StringDictionary<V>> | Custom function that returns true if the constraint is satisfied, false or a custom error message if not. |
options? |
object | - |
options.args? |
K | - |
options.name? |
string | - |
Returns: Constraint<StringDictionary<V>, T, K>
Inherited from: Runtype
Defined in: src/runtype.ts:74
▸ withGuard<T, K>(guard: (x: { [_: string]: Static<V>; }) => x is T, options?: { args?: K ; name?: string }): Constraint<StringDictionary<V>, T, K>
Helper function to convert an underlying Runtype into another static type via a type guard function. The static type of the runtype is inferred from the type of the guard function.
| Name | Type | Default | Description |
|---|---|---|---|
T |
object | - | Typically inferred from the return type of the type guard function, so usually not needed to specify manually. |
K |
- | unknown | - |
| Name | Type | Description |
|---|---|---|
guard |
(x: { [_: string]: Static<V>; }) => x is T |
Type guard function (see https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards) |
options? |
object | - |
options.args? |
K | - |
options.name? |
string | - |
Returns: Constraint<StringDictionary<V>, T, K>
Inherited from: Runtype
Defined in: src/runtype.ts:94