Skip to content

modules.md

Latest commit

 

History

History
180 lines (109 loc) · 5.87 KB

modules.md

File metadata and controls

180 lines (109 loc) · 5.87 KB

@zimmed/const / Exports

@zimmed/const

Table of contents

Type aliases

Properties

Functions

Type aliases

Constant

Ƭ Constant<K>: Object

Type parameters

Name Type
K extends string

Type declaration

Name Type
label string
value K

Defined in

const.ts:6

Properties

default

• default: Object

Type declaration

Name Type
create <K, T>(value: K, __namedParameters: { $label?: string ; label?: string } & Partial<T>) => Constant<K> & T
createMap <O>(constMap: O, $label?: string) => { readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>
createMapStrict <T>() => <O>(constMap: O, $label?: string) => { readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>
createStrictMap <T>() => <O>(constMap: O, $label?: string) => { readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>
createTypedMap <T>() => <O>(constMap: O, $label?: string) => { readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>
list <T>(...keys: T[]) => R

Functions

createConst

▸ createConst<K, T>(value, __namedParameters?): Constant<K> & T

Type parameters

Name Type
K extends string
T extends Object

Parameters

Name Type
value K
__namedParameters { $label?: string ; label?: string } & Partial<T>

Returns

Constant<K> & T

Defined in

const.ts:11

createConstList

▸ createConstList<T>(...keys): R

Type parameters

Name Type
T extends string

Parameters

Name Type
...keys T[]

Returns

R

Defined in

const.ts:66

createConstMap

▸ createConstMap<O>(constMap, $label?): { readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>

Type parameters

Name Type
O extends Object

Parameters

Name Type
constMap O
$label? string

Returns

{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>

Defined in

const.ts:33

createConstMapStrict

▸ createConstMapStrict<T>(): <O>(constMap: O, $label?: string) => { readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>

Type parameters

Name Type
T extends Object

Returns

fn

▸ <O>(constMap, $label?): { readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>

Type parameters
Name Type
O extends Object
Parameters
Name Type
constMap O
$label? string
Returns

{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} & Iterable<{ readonly[K in string | number | symbol]: K extends string ? Constant<K> & Omit<O[K], "label" | "$label"> : never} extends { [k: string]: infer C; } ? C : never>

Defined in

const.ts:61