pure-parse/dist/parsers/primitives.d.ts

Strongly typed validation library that decouples type aliases from validation logic

import { ParseFailure, ParseSuccess } from './ParseResult';
/**
 * Parse `undefined`
 * @example
 * parseUndefined(undefined) // => ParseSuccess<undefined>
 * parseUndefined(null) // => ParseFailure
 * @param data data to be validated
 */
export declare const parseUndefined: (data: unknown) => ParseSuccess<undefined> | ParseFailure;
/**
 * Parse `null`
 * @example
 * parseNull(null) // => ParseSuccess<null>
 * @example
 * parseNull(undefined) // => ParseFailure
 * @param data data to be validated
 */
export declare const parseNull: (data: unknown) => ParseSuccess<null> | ParseFailure;
/**
 * Parse `boolean`
 * @example
 * parseBoolean(true) // => ParseSuccess<boolean>
 * @example
 * parseBoolean(false) // => ParseSuccess<boolean>
 * @example
 * parseBoolean(0) // => ParseFailure
 * @param data data to be validated
 */
export declare const parseBoolean: (data: unknown) => ParseSuccess<boolean> | ParseFailure;
/**
 * Parse `number`
 * @example
 * parseNumber(0) // => ParseSuccess<number>
 * @example
 * parseNumber('0') // => ParseFailure
 * @param data data to be validated
 */
export declare const parseNumber: (data: unknown) => ParseSuccess<number> | ParseFailure;
/**
 * Parse `string`
 * @example
 * parseString('abc') // => ParseSuccess<string>
 * @example
 * parseString(0) // => ParseFailure
 * @param data data to be validated
 */
export declare const parseString: (data: unknown) => ParseSuccess<string> | ParseFailure;
/**
 * Parse `bigint`
 * @example
 * parseBigInt(0n) // => ParseSuccess<bigint>
 * @example
 * parseBigInt(0) // => ParseFailure
 * @param data data to be validated
 */
export declare const parseBigInt: (data: unknown) => ParseSuccess<bigint> | ParseFailure;
/**
 * Parse `symbol`
 * @example
 * parseSymbol(Symbol('abc')) // => ParseSuccess<symbol>
 * @example
 * parseSymbol('abc') // => ParseFailure
 * @param data data to be validated
 */
export declare const parseSymbol: (data: unknown) => ParseSuccess<symbol> | ParseFailure;