Skip to content

Commit bbc9b44

Browse files
committed
Removed class structure.
1 parent 16363f1 commit bbc9b44

File tree

7 files changed

+37
-340
lines changed

7 files changed

+37
-340
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A simple library for managing Constants in project features.
44

5-
> [Documentation](docs/README.md)
5+
> [Typedocs](docs/modules.md)
66
77
![Jest Branch Coverage](coverage/badge-branches.svg)
88
![Jest Function Coverage](coverage/badge-functions.svg)

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
A simple library for managing Constants in project features.
66

7-
> [Documentation](docs/README.md)
7+
> [Typedocs](docs/modules.md)
88
99
![Jest Branch Coverage](coverage/badge-branches.svg)
1010
![Jest Function Coverage](coverage/badge-functions.svg)

docs/classes/default.md

Lines changed: 0 additions & 225 deletions
This file was deleted.

docs/modules.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,14 @@
44

55
## Table of contents
66

7-
### Namespaces
8-
9-
- [createConstMap](modules/createConstMap.md)
10-
11-
### Classes
12-
13-
- [default](classes/default.md)
14-
157
### Type aliases
168

179
- [Constant](modules.md#constant)
1810

11+
### Properties
12+
13+
- [default](modules.md#default)
14+
1915
### Functions
2016

2117
- [createConst](modules.md#createconst)
@@ -44,7 +40,24 @@
4440

4541
#### Defined in
4642

47-
[const.ts:6](https://github.com/zimmed/const/blob/f05162f/src/const.ts#L6)
43+
[const.ts:6](https://github.com/zimmed/const/blob/16363f1/src/const.ts#L6)
44+
45+
## Properties
46+
47+
### default
48+
49+
**default**: `Object`
50+
51+
#### Type declaration
52+
53+
| Name | Type |
54+
| :------ | :------ |
55+
| `create` | <K, T\>(`value`: `K`, `__namedParameters`: { `$label?`: `string` ; `label?`: `string` } & `Partial`<`T`\>) => [`Constant`](modules.md#constant)<`K`\> & `T` |
56+
| `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`\> |
57+
| `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`\> |
58+
| `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`\> |
59+
| `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`\> |
60+
| `list` | <T\>(...`keys`: `T`[]) => `R` |
4861

4962
## Functions
5063

@@ -72,7 +85,7 @@
7285

7386
#### Defined in
7487

75-
[const.ts:11](https://github.com/zimmed/const/blob/f05162f/src/const.ts#L11)
88+
[const.ts:11](https://github.com/zimmed/const/blob/16363f1/src/const.ts#L11)
7689

7790
___
7891

@@ -98,7 +111,7 @@ ___
98111

99112
#### Defined in
100113

101-
[const.ts:66](https://github.com/zimmed/const/blob/f05162f/src/const.ts#L66)
114+
[const.ts:66](https://github.com/zimmed/const/blob/16363f1/src/const.ts#L66)
102115

103116
___
104117

@@ -125,7 +138,7 @@ ___
125138

126139
#### Defined in
127140

128-
[const.ts:33](https://github.com/zimmed/const/blob/f05162f/src/const.ts#L33)
141+
[const.ts:33](https://github.com/zimmed/const/blob/16363f1/src/const.ts#L33)
129142

130143
___
131144

@@ -164,4 +177,4 @@ ___
164177

165178
#### Defined in
166179

167-
[const.ts:61](https://github.com/zimmed/const/blob/f05162f/src/const.ts#L61)
180+
[const.ts:61](https://github.com/zimmed/const/blob/16363f1/src/const.ts#L61)

0 commit comments

Comments
 (0)