@vicin/phantom 1.0.2 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -3
- package/dist/index.d.mts +1353 -0
- package/dist/index.d.ts +1353 -7
- package/dist/index.global.js +135 -0
- package/dist/index.global.js.map +1 -0
- package/dist/index.js +129 -5
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +117 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +6 -2
- package/dist/assertors/assertors.d.ts +0 -86
- package/dist/assertors/assertors.d.ts.map +0 -1
- package/dist/assertors/assertors.js +0 -91
- package/dist/assertors/assertors.js.map +0 -1
- package/dist/assertors/brand.d.ts +0 -13
- package/dist/assertors/brand.d.ts.map +0 -1
- package/dist/assertors/brand.js +0 -12
- package/dist/assertors/brand.js.map +0 -1
- package/dist/assertors/identity.d.ts +0 -13
- package/dist/assertors/identity.d.ts.map +0 -1
- package/dist/assertors/identity.js +0 -12
- package/dist/assertors/identity.js.map +0 -1
- package/dist/assertors/index.d.ts +0 -2
- package/dist/assertors/index.d.ts.map +0 -1
- package/dist/assertors/index.js +0 -2
- package/dist/assertors/index.js.map +0 -1
- package/dist/assertors/trait.d.ts +0 -38
- package/dist/assertors/trait.d.ts.map +0 -1
- package/dist/assertors/trait.js +0 -37
- package/dist/assertors/trait.js.map +0 -1
- package/dist/assertors/transformation.d.ts +0 -27
- package/dist/assertors/transformation.d.ts.map +0 -1
- package/dist/assertors/transformation.js +0 -26
- package/dist/assertors/transformation.js.map +0 -1
- package/dist/chain/chain.d.ts +0 -42
- package/dist/chain/chain.d.ts.map +0 -1
- package/dist/chain/chain.js +0 -48
- package/dist/chain/chain.js.map +0 -1
- package/dist/chain/index.d.ts +0 -2
- package/dist/chain/index.d.ts.map +0 -1
- package/dist/chain/index.js +0 -2
- package/dist/chain/index.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/phantom.d.ts +0 -352
- package/dist/phantom.d.ts.map +0 -1
- package/dist/phantom.js +0 -139
- package/dist/phantom.js.map +0 -1
- package/dist/types/composed/brand.d.ts +0 -32
- package/dist/types/composed/brand.d.ts.map +0 -1
- package/dist/types/composed/brand.js +0 -2
- package/dist/types/composed/brand.js.map +0 -1
- package/dist/types/composed/helpers.d.ts +0 -75
- package/dist/types/composed/helpers.d.ts.map +0 -1
- package/dist/types/composed/helpers.js +0 -2
- package/dist/types/composed/helpers.js.map +0 -1
- package/dist/types/composed/identity.d.ts +0 -37
- package/dist/types/composed/identity.d.ts.map +0 -1
- package/dist/types/composed/identity.js +0 -2
- package/dist/types/composed/identity.js.map +0 -1
- package/dist/types/composed/index.d.ts +0 -6
- package/dist/types/composed/index.d.ts.map +0 -1
- package/dist/types/composed/index.js +0 -2
- package/dist/types/composed/index.js.map +0 -1
- package/dist/types/composed/trait.d.ts +0 -35
- package/dist/types/composed/trait.d.ts.map +0 -1
- package/dist/types/composed/trait.js +0 -2
- package/dist/types/composed/trait.js.map +0 -1
- package/dist/types/composed/transformation.d.ts +0 -34
- package/dist/types/composed/transformation.d.ts.map +0 -1
- package/dist/types/composed/transformation.js +0 -2
- package/dist/types/composed/transformation.js.map +0 -1
- package/dist/types/core/base.d.ts +0 -35
- package/dist/types/core/base.d.ts.map +0 -1
- package/dist/types/core/base.js +0 -2
- package/dist/types/core/base.js.map +0 -1
- package/dist/types/core/index.d.ts +0 -8
- package/dist/types/core/index.d.ts.map +0 -1
- package/dist/types/core/index.js +0 -2
- package/dist/types/core/index.js.map +0 -1
- package/dist/types/core/input.d.ts +0 -38
- package/dist/types/core/input.d.ts.map +0 -1
- package/dist/types/core/input.js +0 -2
- package/dist/types/core/input.js.map +0 -1
- package/dist/types/core/label.d.ts +0 -34
- package/dist/types/core/label.d.ts.map +0 -1
- package/dist/types/core/label.js +0 -2
- package/dist/types/core/label.js.map +0 -1
- package/dist/types/core/phantom.d.ts +0 -20
- package/dist/types/core/phantom.d.ts.map +0 -1
- package/dist/types/core/phantom.js +0 -11
- package/dist/types/core/phantom.js.map +0 -1
- package/dist/types/core/tag.d.ts +0 -35
- package/dist/types/core/tag.d.ts.map +0 -1
- package/dist/types/core/tag.js +0 -2
- package/dist/types/core/tag.js.map +0 -1
- package/dist/types/core/traits.d.ts +0 -51
- package/dist/types/core/traits.d.ts.map +0 -1
- package/dist/types/core/traits.js +0 -2
- package/dist/types/core/traits.js.map +0 -1
- package/dist/types/core/variants.d.ts +0 -34
- package/dist/types/core/variants.d.ts.map +0 -1
- package/dist/types/core/variants.js +0 -2
- package/dist/types/core/variants.js.map +0 -1
- package/dist/types/errors.d.ts +0 -40
- package/dist/types/errors.d.ts.map +0 -1
- package/dist/types/errors.js +0 -2
- package/dist/types/errors.js.map +0 -1
- package/dist/types/index.d.ts +0 -4
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/index.js +0 -2
- package/dist/types/index.js.map +0 -1
- package/dist/types/public.d.ts +0 -224
- package/dist/types/public.d.ts.map +0 -1
- package/dist/types/public.js +0 -12
- package/dist/types/public.js.map +0 -1
package/README.md
CHANGED
|
@@ -9,7 +9,14 @@
|
|
|
9
9
|
- [Features](#features)
|
|
10
10
|
- [Install](#install)
|
|
11
11
|
- [Core concepts](#core-concepts)
|
|
12
|
-
- [
|
|
12
|
+
- [Type constructs](#type-constructs)
|
|
13
|
+
- [Branding](#branding)
|
|
14
|
+
- [Identities with constraints](#identities-with-constraints)
|
|
15
|
+
- [Traits (additive capabilities)](#traits-additive-capabilities)
|
|
16
|
+
- [Transformations (Type pipe-like behavior)](#transformations-type-pipe-like-behavior)
|
|
17
|
+
- [Errors](#errors)
|
|
18
|
+
- [Symbols](#symbols)
|
|
19
|
+
- [Imports](#imports)
|
|
13
20
|
- [Chaining](#chaining)
|
|
14
21
|
- [Hot-path code ( truly type-only pattern )](#hot-path-code--truly-type-only-pattern-)
|
|
15
22
|
- [Debugging](#debugging)
|
|
@@ -116,7 +123,7 @@ More details of these properties will be discussed later.
|
|
|
116
123
|
|
|
117
124
|
---
|
|
118
125
|
|
|
119
|
-
##
|
|
126
|
+
## Type constructs
|
|
120
127
|
|
|
121
128
|
### Branding
|
|
122
129
|
|
|
@@ -426,7 +433,7 @@ type UserId = Brand.Declare<typeof __UserId, 'User id'>;
|
|
|
426
433
|
export const asUserId = assertors.asBrand<UserId>();
|
|
427
434
|
```
|
|
428
435
|
|
|
429
|
-
|
|
436
|
+
If you prefer default imports you can just:
|
|
430
437
|
|
|
431
438
|
```ts
|
|
432
439
|
import P from '@vicin/phantom';
|
|
@@ -439,6 +446,14 @@ type UserId = P.Brand.Declare<typeof __UserId, 'User id'>;
|
|
|
439
446
|
export const asUserId = P.assertors.asBrand<UserId>();
|
|
440
447
|
```
|
|
441
448
|
|
|
449
|
+
Also you can import single assertor function:
|
|
450
|
+
|
|
451
|
+
```ts
|
|
452
|
+
import { asBrand } from '@vicin/phantom';
|
|
453
|
+
|
|
454
|
+
export const asUserId = assertors.asBrand<UserId>();
|
|
455
|
+
```
|
|
456
|
+
|
|
442
457
|
You are free to pick whatever pattern you are comfortable with.
|
|
443
458
|
|
|
444
459
|
---
|