Effect-TSでより型安全なコードを書く

1
{
2
  "bigBoss": "SakelienGiant",
3
  "phaseId": "664a94e1db05b9e98a069059",
4
  "startTime": "2024-05-26T16:00:00Z",
5
  "endTime": "2024-05-28T08:00:00Z",
6
  "stage": 4,
7
  "weapons": [
8
    200,
9
    6000,
10
    1020,
11
    2050
12
  ],
13
  "rareWeapons": []
14
}

1
import { Schema as S } from '@effect/schema'
2

3
const CreateScheduleSchema = S.Struct({
4
  bigBoss: S.String,
5
  phaseId: S.String,
6
  startTime: S.String,
7
  endTime: S.String,
8
  stage: S.Number,
9
  weapons: S.Array(S.Number),
10
  rareWeapons: S.Array(S.Number)
11
})
12

13
type CreateScheduleSchema = typeof CreateScheduleSchema.Type

1
import { describe, test } from 'bun:test'
2

3
describe('Strucutre', () => {
4
  test('Schema', () => {
5
    CreateScheduleSchema.make({
6
      bigBoss: 'SakelienGiant',
7
      phaseId: '664a94e1db05b9e98a069059',
8
      startTime: '2024-05-26T16:00:00Z',
9
      endTime: '2024-05-28T08:00:00Z',
10
      stage: 4,
11
      weapons: [200, 6000, 1020, 2050],
12
      rareWeapons: []
13
    })
14
  })
15
})

1
import { Schema as S } from '@effect/schema'
2

3
const CreateScheduleSchema = S.Struct({
4
  bigBoss: S.String,
5
  phaseId: S.String,
6
  startTime: S.String,
7
  endTime: S.String,
8
  stage: S.Number,
9
  weapons: S.Array(S.Number),
10
  rareWeapons: S.Array(S.Number)
11
})
12

13
type CreateScheduleSchema = typeof CreateScheduleSchema.Type

1
export namespace WeaponInfoMain {
2
  export enum Id {
3
    Dummy = -999,
4
    RandomGold = -2,
5
    RandomGreen = -1,
6
    ShooterShort = 0,
7
  }
8
}
9

10
export namespace CoopStage {
11
  export enum Id {
12
    Dummy = -999,
13
    Tutorial = 0,
14
    Shakeup = 1
15
  }
16
}

1
export const CreateScheduleSchema = S.Struct({
2
  bigBoss: S.String,
3
  phaseId: S.String,
4
  startTime: S.String,
5
  endTime: S.String,
6
  stage: S.Enums(CoopStage.Id),
7
  weapons: S.Array(S.Enums(WeaponInfoMain.Id)),
8
  rareWeapons: S.Array(S.Enums(WeaponInfoMain.Id))
9
})

1
describe('Strucutre', () => {
2
  test('Schema', () => {
3
    const data = {
4
      bigBoss: 'SakelienGiant',
5
      phaseId: '664a94e1db05b9e98a069059',
6
      startTime: '2024-05-26T16:00:00Z',
7
      endTime: '2024-05-28T08:00:00Z',
8
      stage: 4,
9
      weapons: [200, 6000, 1020, 2050],
10
      rareWeapons: []
11
    }
12
    const decoderSync = Schema.decodeUnknownSync(CreateScheduleSchema)
13
    const decoderOption = Schema.decodeUnknownOption(CreateScheduleSchema)
14
    const decoderEither = Schema.decodeUnknownEither(CreateScheduleSchema)
15
    const decoderPromise = Schema.decodeUnknownPromise(CreateScheduleSchema)
16
    const decoderUnknown = Schema.decodeUnknown(CreateScheduleSchema)
17
  })
18
})

1
console.log(decoderSync(data))
2
// {
3
//   bigBoss: "SakelienGiant",
4
//   phaseId: "664a94e1db05b9e98a069059",
5
//   stage: 104,
6
//   weapons: [ 200, 6000, 1020, 2050 ],
7
//   rareWeapons: [],
8
// }

1
console.log(decoderEither(data))
2
// {
3
//   _id: "Either",
4
//   _tag: "Right",
5
//   right: {
6
//     bigBoss: "SakelienGiant",
7
//     phaseId: "664a94e1db05b9e98a069059",
8
//     stage: 104,
9
//     weapons: [ 200, 6000, 1020, 2050 ],
10
//     rareWeapons: [],
11
//   },
12
// }

1
console.log(decoderOption(data))
2
// {
3
//   _id: "Option",
4
//   _tag: "Some",
5
//   value: {
6
//     bigBoss: "SakelienGiant",
7
//     phaseId: "664a94e1db05b9e98a069059",
8
//     stage: 104,
9
//     weapons: [ 200, 6000, 1020, 2050 ],
10
//     rareWeapons: [],
11
//   },
12
// }

1
console.log(decoderPromise(data))
2
// Promise { <pending> }
3
console.log(await decoderPromise(data))
4
// {
5
//   bigBoss: "SakelienGiant",
6
//   phaseId: "664a94e1db05b9e98a069059",
7
//   stage: 104,
8
//   weapons: [ 200, 6000, 1020, 2050 ],
9
//   rareWeapons: [],
10
// }

1
console.log(decoderUnknown(data))
2
// {
3
//   _id: "Either",
4
//   _tag: "Right",
5
//   right: {
6
//     bigBoss: "SakelienGiant",
7
//     phaseId: "664a94e1db05b9e98a069059",
8
//     stage: 104,
9
//     weapons: [ 200, 6000, 1020, 2050 ],
10
//     rareWeapons: [],
11
//   },
12
// }

1
/**
2
 * @category model
3
 * @since 1.0.0
4
 */
5
export interface ParseOptions {
6
  /** default "first" */
7
  readonly errors?: "first" | "all" | undefined
8
  /** default "ignore" */
9
  readonly onExcessProperty?: "ignore" | "error" | "preserve" | undefined
10
}

1
export const CreateScheduleSchema = S.Struct({
2
  bigBoss: S.String,
3
  phaseId: S.String,
4
  startTime: S.String,
5
  endTime: S.String,
6
  stage: S.Enums(CoopStage.Id),
7
  weapons: S.Array(S.Enums(WeaponInfoMain.Id)),
8
  rareWeapons: S.Array(S.Enums(WeaponInfoMain.Id))
9
})

1
import * as S from "@effect/schema/Schema";
2

3
interface Category {
4
  readonly name: string;
5
  readonly subcategories: ReadonlyArray<Category>;
6
}
7

8
const   name: S.String,
9
  subcategories: S.Array(S.suspend(() => Category)),
10
});

1
enum Fruits {
2
  Apple,
3
  Banana,
4
}
5

6
// $ExpectType Schema<Fruits>
7
S.Enums(Fruits);

1
// $ExpectType Schema<String | null>
2
S.Nullable(S.String);

1
// $ExpectType Schema<String | Number>
2
S.Union(S.String, S.Number);

1
// $ExpectType Schema<readonly [String, Number]>
2
S.Tuple(S.String, S.Number);

1
// $ExpectType Schema<readonly Number[]>
2
S.Array(S.Number);

1
// $ExpectType Schema<Number[]>
2
S.Mutable(S.Array(S.Number));

1
S.NonEmptyArray(S.Number);

1
// $ExpectType Schema<{ readonly a: String; readonly b: Number; }>
2
S.Struct({ a: S.String, b: S.Number });

1
S.String.pipe(S.MaxLength(5)); // 最大長さ
2
S.String.pipe(S.MinLength(5)); // 最低長さ
3
S.String.pipe(NonEmpty()); // 空文字を許容しない same as S.minLength(1)
4
S.String.pipe(S.Length(5)); // 文字数指定
5
S.String.pipe(S.Pattern(regex)); // 正規表現にマッチ
6
S.String.pipe(S.StartsWith(string)); // 先頭を指定
7
S.String.pipe(S.EndsWith(string)); // 末尾を指定
8
S.String.pipe(S.Includes(searchString)); // 指定文字列を含む
9
S.String.pipe(S.Trimmed()); // 前後の空白削除 verifies that a string contains no leading or trailing whitespaces
10
S.String.pipe(S.Lowercased()); // 小文字のみ許容 verifies that a string is lowercased

1
S.Number.pipe(S.GreaterThan(5)); // 5 < x
2
S.Number.pipe(S.GreaterThanOrEqualTo(5)); // 5 <= x
3
S.Number.pipe(S.LessThan(5)); // x < 5
4
S.Number.pipe(S.LessThanOrEqualTo(5)); // x <= 5
5
S.Number.pipe(S.Between(-2, 2)); // -2 <= x <= 2
6
S.Number.pipe(S.Int()); // 整数型 value must be an integer
7
S.Number.pipe(S.NonNaN()); // 数値 not NaN
8
S.Number.pipe(S.Finite()); // 有限の数
9
S.Number.pipe(S.Positive()); // 0 < x
10
S.Number.pipe(S.NonNegative()); // 0 <= x
11
S.Number.pipe(S.Negative()); // x < 0
12
S.Number.pipe(S.NonPositive()); // x <= 0
13
S.Number.pipe(S.MultipleOf(5)); // 5の倍数

1
S.Bigint.pipe(S.GreaterThanBigint(5n));
2
S.Bigint.pipe(S.GreaterThanOrEqualToBigint(5n));
3
S.Bigint.pipe(S.LessThanBigint(5n));
4
S.Bigint.pipe(S.LessThanOrEqualToBigint(5n));
5
S.Bigint.pipe(S.BetweenBigint(-2n, 2n)); // -2n <= x <= 2n
6
S.Bigint.pipe(S.PositiveBigint()); // 0n < x
7
S.Bigint.pipe(S.NonNegativeBigint()); // 0n <= x
8
S.Bigint.pipe(S.NegativeBigint()); // x < 0n
9
S.Bigint.pipe(S.NonPositiveBigint()); // x <= 0n

1
S.BigDecimal.pipe(S.GreaterThanBigDecimal(BigDecimal.FromNumber(5)));
2
S.BigDecimal.pipe(S.GreaterThanOrEqualToBigDecimal(BigDecimal.FromNumber(5)));
3
S.BigDecimal.pipe(S.LessThanBigDecimal(BigDecimal.FromNumber(5)));
4
S.BigDecimal.pipe(S.LessThanOrEqualToBigDecimal(BigDecimal.FromNumber(5)));
5
S.BigDecimal.pipe(
6
  S.BetweenBigDecimal(BigDecimal.FromNumber(-2), BigDecimal.FromNumber(2))
7
);
8

9
S.BigDecimal.pipe(S.PositiveBigDecimal());
10
S.BigDecimal.pipe(S.NonNegativeBigDecimal());
11
S.BigDecimal.pipe(S.NegativeBigDecimal());
12
S.BigDecimal.pipe(S.NonPositiveBigDecimal());

1
S.Duration.pipe(S.GreaterThanDuration("5 seconds"));
2
S.Duration.pipe(S.GreaterThanOrEqualToDuration("5 seconds"));
3
S.Duration.pipe(S.LessThanDuration("5 seconds"));
4
S.Duration.pipe(S.LessThanOrEqualToDuration("5 seconds"));
5
S.Duration.pipe(S.BetweenDuration("5 seconds", "10 seconds"));

1
S.Array(S.Number).pipe(S.MaxItems(2)); // max array length
2
S.Array(S.Number).pipe(S.MinItems(2)); // min array length
3
S.Array(S.Number).pipe(S.ItemsCount(2)); // exact array length