the-moby-effect
Version:
Moby/Docker API client built using effect-ts
70 lines • 2.15 kB
JavaScript
/**
* IPv4 and IPv4 CidrBlock mask schemas.
*
* @since 1.0.0
*/
import * as Brand from "effect/Brand";
import * as Schema from "effect/Schema";
/**
* @since 1.0.0
* @category Branded constructors
*/
export const IPv4CidrMaskBrand = /*#__PURE__*/Brand.nominal();
/**
* An ipv4 cidr mask, which is a number between 0 and 32.
*
* @since 1.0.0
* @category Schemas
* @example
* import * as Schema from "effect/Schema";
* import {
* IPv4CidrMask,
* IPv4CidrMaskBrand,
* } from "the-moby-effect/schemas/CidrBlockMask.js";
*
* const mask: IPv4CidrMaskBrand = IPv4CidrMaskBrand(24);
* assert.strictEqual(mask, 24);
*
* const decodeMask = Schema.decodeSync(IPv4CidrMask);
* assert.strictEqual(decodeMask(24), 24);
*
* assert.throws(() => decodeMask(33));
* assert.doesNotThrow(() => decodeMask(0));
* assert.doesNotThrow(() => decodeMask(32));
*/
export const IPv4CidrMask = /*#__PURE__*/Schema.Int.pipe(Schema.between(0, 32)).pipe(Schema.fromBrand(IPv4CidrMaskBrand)).annotations({
identifier: "IPv4CidrMask",
description: "An ipv4 cidr mask"
});
/**
* @since 1.0.0
* @category Branded constructors
*/
export const IPv6CidrMaskBrand = /*#__PURE__*/Brand.nominal();
/**
* An ipv6 cidr mask, which is a number between 0 and 128.
*
* @since 1.0.0
* @category Schemas
* @example
* import * as Schema from "effect/Schema";
* import {
* IPv6CidrMask,
* IPv6CidrMaskBrand,
* } from "the-moby-effect/schemas/CidrBlockMask.js";
*
* const mask: IPv6CidrMaskBrand = IPv6CidrMaskBrand(64);
* assert.strictEqual(mask, 64);
*
* const decodeMask = Schema.decodeSync(IPv6CidrMask);
* assert.strictEqual(decodeMask(64), 64);
*
* assert.throws(() => decodeMask(129));
* assert.doesNotThrow(() => decodeMask(0));
* assert.doesNotThrow(() => decodeMask(128));
*/
export const IPv6CidrMask = /*#__PURE__*/Schema.Int.pipe(Schema.between(0, 128)).pipe(Schema.fromBrand(IPv6CidrMaskBrand)).annotations({
identifier: "IPv6CidrMask",
description: "An ipv6 cidr mask"
});
//# sourceMappingURL=cidrBlockMask.js.map