-
Notifications
You must be signed in to change notification settings - Fork 328
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
The `enum` is a popular aspect of TypeScript, and can be embedded in
interfaces as a concise, but descriptive, shorthand for literal string
unions:
```typescript
enum Colour {
White = '000000',
Black = 'ffffff'
}
```
This change adds an exported member `enum` to `io-ts`, based on
[this suggestion][1] by @noe132
It means that `enum`s can be reused directly in `io-ts`:
```typescript
const T = t.enum(Colour)
```
[1]: #216 (comment)- Loading branch information
Alec Gibson
committed
Jan 4, 2021
1 parent
f13a10a
commit 9a34f36
Showing
4 changed files
with
183 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| import * as assert from 'assert' | ||
| import * as t from '../src/index' | ||
| import * as _ from '../src/Decoder' | ||
| import { isLeft } from 'fp-ts/lib/Either' | ||
|
|
||
| describe('enum', () => { | ||
| enum A { | ||
| Foo = 'foo', | ||
| Bar = 'bar' | ||
| } | ||
|
|
||
| enum B { | ||
| Foo, | ||
| Bar | ||
| } | ||
|
|
||
| describe('name', () => { | ||
| it('should assign a default name', () => { | ||
| const T = t.enum(A) | ||
| assert.strictEqual(T.name, 'enum') | ||
| }) | ||
|
|
||
| it('should accept a name', () => { | ||
| const T = t.enum(A, 'T') | ||
| assert.strictEqual(T.name, 'T') | ||
| }) | ||
| }) | ||
|
|
||
| describe('is', () => { | ||
| it('should check an enum string value', () => { | ||
| const T = t.enum(A) | ||
| assert.strictEqual(T.is(A.Foo), true) | ||
| assert.strictEqual(T.is('bar'), true) | ||
| assert.strictEqual(T.is('invalid'), false) | ||
| assert.strictEqual(T.is(null), false) | ||
| assert.strictEqual(T.is(A), false) | ||
| }) | ||
|
|
||
| it('should check an enum integer value', () => { | ||
| const T = t.enum(B) | ||
| assert.strictEqual(T.is(B.Foo), true) | ||
| assert.strictEqual(T.is(1), true) | ||
| assert.strictEqual(T.is('Foo'), false) | ||
| assert.strictEqual(T.is('invalid'), false) | ||
| assert.strictEqual(T.is(null), false) | ||
| assert.strictEqual(T.is(B), false) | ||
| }) | ||
| }) | ||
|
|
||
| describe('decode', () => { | ||
| it('should decode an enum string value', () => { | ||
| const T = t.enum(A) | ||
| assert.deepStrictEqual(T.decode(A.Foo), _.success(A.Foo)) | ||
| assert.deepStrictEqual(T.decode('bar'), _.success('bar')) | ||
| }) | ||
|
|
||
| it('should decode an enum integer value', () => { | ||
| const T = t.enum(B) | ||
| assert.deepStrictEqual(T.decode(B.Foo), _.success(B.Foo)) | ||
| assert.deepStrictEqual(T.decode(1), _.success(1)) | ||
| }) | ||
|
|
||
| it('should fail decoding an invalid string value', () => { | ||
| const T = t.enum(A) | ||
| assert.deepStrictEqual(isLeft(T.decode('invalid')), true) | ||
| }) | ||
|
|
||
| it('should fail decoding an invalid integer value', () => { | ||
| const T = t.enum(B) | ||
| assert.deepStrictEqual(isLeft(T.decode(2)), true) | ||
| }) | ||
| }) | ||
|
|
||
| describe('encode', () => { | ||
| it('should encode an enum string value', () => { | ||
| const T = t.enum(A) | ||
| assert.deepStrictEqual(T.encode(A.Foo), A.Foo) | ||
| }) | ||
|
|
||
| it('should encode an enum integer value', () => { | ||
| const T = t.enum(B) | ||
| assert.deepStrictEqual(T.encode(B.Foo), B.Foo) | ||
| }) | ||
| }) | ||
| }) |