Refine ユーティリティ

チェッカーコンビネーターの中核に加えて、Refineによって提供されるライブラリは、JSON パースやアサーション関数などの処理に役立ついくつかのユーティリティ関数を公開します。

coercion()

値を null に強制する関数（オプションでチェック結果のコールバック付き）を簡単に作成します

let callbackResult: ?CheckResult<Date> = null;

// optional callback
const onResult = (result: CheckResult<Date>) => {
  callbackResult = result;
};

// mixed => ?Date
const coerce = coercion(date(), onResult);

const d = new Date();

assert(coerce(d) === d, 'should resolve to value');
assert(callbackResult != null, 'should be set');
assert(callbackResult.type == 'success', 'should succeed');

assertion()

チェッカー関数からアサーション関数を簡単に作成できます。

// mixed => $ReadOnlyArray<number>;
const assertArrayOfNum = assertion(array(number()));

declare value: mixed;

try {
  const myArray: $ReadOnlyArray<number> = assertArrayOfNum(value);
} catch {
  // assertion error if value is invalid
}

CheckerReturnType<Checker>

チェッカー関数から基になる型を抽出するには、CheckerReturnType<typeof checker>を使用できます...

const check = array(number());

// $ReadOnlyArray<number>;
type MyArray = CheckerReturnType<typeof check>;

jsonParser() / jsonParserEnforced()

チェッカー関数から JSON パーサーを簡単に作成できます。

// ?string => ?$ReadOnlyArray<number>;
const parse = jsonParser(array(number()));

const result = parse('[1,2,3]']);

無効/null JSON でスローしたい場合は、jsonParserEnforced()を使用できます

// creates a json parser which will throw on invalid values
const parse = jsonParserEnforced(
  object({a: string(), b: nullable(number()), c: bool()}),

  // message to append to error message
  'Configuration is invalid'
);

const result = parse('...');

// at this point, result must be correct, or `parse()` would throw...
result.a.includes(...);