/** * Natural branded newtype. * * Represents integers: * * ```math * { z | z ∈ ℤ, z >= 0, z <= 2 ** 53 - 1 } * ``` * * @since 0.0.1 */ import * as Enc from 'io-ts/Encoder' import { Kind, Kind2, URIS, URIS2, HKT2 } from 'fp-ts/HKT' import * as D from 'io-ts/Decoder' import * as Eq_ from 'fp-ts/Eq' import * as G from 'io-ts/Guard' import * as TD from 'io-ts/TaskDecoder' import * as t from 'io-ts/Type' import * as N from 'fp-ts/number' import { pipe } from 'fp-ts/function' import * as fc from 'fast-check' import * as Arb from '../internal/ArbitraryBase' import { isInt } from './Int' /** * @since 0.0.1 * @internal */ interface NaturalBrand { readonly Natural: unique symbol } /** * Natural branded newtype. * * Represents integers: * * ```math * { z | z ∈ ℤ, z >= 0, z <= 2 ** 53 - 1 } * ``` * * @since 0.0.1 * @category Model */ export type Natural = number & NaturalBrand /** * @since 0.0.1 * @category Model */ export type SchemableParams = HKT2 /** * @since 0.0.1 * @category Model */ export type SchemableParams1 = Kind /** * @since 0.0.3 * @category Model */ export type SchemableParams2 = Kind2 /** * @since 0.0.1 * @category Model */ export type SchemableParams2C = Kind2 /** * @since 0.0.1 * @category Refinements */ export function isNatural(n: number): n is Natural { return isInt(n) && n >= 0 } /** * @since 0.0.1 * @category Instances */ export const Decoder: SchemableParams2C = pipe( D.number, D.refine(isNatural, 'Natural') ) /** * @since 0.0.1 * @category Instances */ export const Eq: SchemableParams1 = N.Eq /** * @since 0.0.1 * @category Instances */ export const Guard: SchemableParams1 = pipe(G.number, G.refine(isNatural)) /** * @since 0.0.1 * @category Instances */ export const TaskDecoder: SchemableParams2C = pipe( TD.number, TD.refine(isNatural, 'Natural') ) /** * @since 0.0.1 * @category Instances */ export const Type: SchemableParams1 = pipe( t.number, t.refine(isNatural, 'Natural') ) /** * @since 0.0.3 * @category Instances */ export const Encoder: SchemableParams2 = Enc.id() /** * @since 0.0.3 * @category Instances */ export const Arbitrary: SchemableParams1 = fc.nat().filter(isNatural)