typia

import { Atomic } from "./typings/Atomic"; import { IReadableURLSearchParams } from "./IReadableURLSearchParams"; import { IValidation } from "./IValidation"; import { Resolved } from "./Resolved"; import { TypeGuardError } from "./TypeGuardError"; /** * Form data decoder. * * `typia.http.formData()` is a function decoding `FormData` instance, with * automatic type casting to the expected type. When property type is defined as * `boolean` or `Blob` type, `typia.http.formData()` will cast the value to the * expected type when decoding. * * By the way, as `FormData` is not enough to express complex data structures, * `typia.http.formData()` function has some limitations. If target type `T` is * not following those restrictions, compilation errors would be occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array * types are allowed * 4. Union types are never allowed * * Also, `typia.http.formData()` function does not perform validation about the * decoded value. Therefore, if you can't sure that input data is following the * `T` type, it would better to call one of below functions instead. * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input FormData instance * @returns Decoded form FormData */ export declare function formData<T extends object>(input: FormData): Resolved<T>; /** * Form data decoder with type assertion. * * `typia.http.assertFormData()` is a function decoding `FormData` instance, * with automatic type casting to the expected type. When property type is * defined as `boolean` or `Blob` type, `typia.http.assertFormData()` will cast * the value to the expected type when decoding. * * Also, after decoding, `typia.http.assertFormData()` performs type assertion * to the decoded value by combining with {@link assert} function. Therefore, * when the decoded value is not following the `T` type, {@link TypeGuardError} * or custom error generated by _errorFactory_ would be thrown. * * By the way, as `FormData` is not enough to express complex data structures, * `typia.http.assertFormData()` function has some limitations. If target type * `T` is not following those restrictions, compilation errors would be * occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array * types are allowed * 4. Union types are never allowed * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input FormData instance * @param errorFactory Custom error factory. Default is `TypeGuardError` * @returns Decoded form FormData */ export declare function assertFormData<T extends object>(input: FormData, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Resolved<T>; /** * Form data decoder with type checking. * * `typia.http.isFormData()` is a function decoding `FormData` instance, with * automatic type casting to the expected type. When property type is defined as * `boolean` or `Blob` type, `typia.http.isFormData()` will cast the value to * the expected type when decoding. * * Also, after decoding, `typia.http.isFormData()` performs type checking to the * decoded value by combining with {@link is} function. Therefore, when the * decoded value is not following the `T` type, `null` value would be returned. * * By the way, as `FormData` is not enough to express complex data structures, * `typia.http.isFormData()` function has some limitations. If target type `T` * is not following those restrictions, compilation errors would be occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array * types are allowed * 4. Union types are never allowed * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input FormData instance * @returns Decoded form FormData or `null` value */ export declare function isFormData<T extends object>(input: FormData): Resolved<T> | null; /** * Form data decoder with type validation. * * `typia.http.validateFormData()` is a function decoding `FormData` instance, * with automatic type casting to the expected type. When property type is * defined as `boolean` or `Blob` type, `typia.http.validateFormData()` will * cast the value to the expected type when decoding. * * Also, after decoding, `typia.http.validateFormData()` performs type * validation to the decoded value by combining with {@link validate} function. * Therefore, when the decoded value is not following the `T` type, * {@link IValidation.IFailure} would be returned. Otherwise, x@xxxx * IValidation.ISuccess} would be returned. * * By the way, as `FormData` is not enough to express complex data structures, * `typia.http.validateFormData()` function has some limitations. If target type * `T` is not following those restrictions, compilation errors would be * occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string`, `Blob`, `File` or their array * types are allowed * 4. Union types are never allowed * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input FormData instance * @returns Validation result with decoded form FormData */ export declare function validateFormData<T extends object>(input: FormData): IValidation<Resolved<T>>; /** * URL query decoder. * * `typia.http.query()` is a function decoding a query string or an * `URLSearchParams` instance, with automatic type casting to the expected type. * When property type be defined as `boolean` or `number` type, * `typia.http.query()` will cast the value to the expected type when decoding. * * By the way, as URL query is not enough to express complex data structures, * `typia.http.query()` function has some limitations. If target type `T` is not * following those restrictions, compilation errors would be occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 4. Union types are never allowed * * Also, `typia.http.query()` function does not perform validation about the * decoded value. Therefore, if you can't sure that input data is following the * `T` type, it would better to call one of below functions instead. * * - {@link assertQuery} * - {@link isQuery} * - {@link validateQuery} * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @returns Decoded query object */ export declare function query<T extends object>(input: string | IReadableURLSearchParams): Resolved<T>; /** * URL query decoder with type assertion. * * `typia.http.assertQuery()` is a function decoding a query string or an * `URLSearchParams` instance, with automatic type casting to the expected type. * When property type is defined as `boolean` or `number` type, * `typia.http.assertQuery()` will cast the value to the expected type when * decoding. * * Also, after decoding, `typia.http.assertQuery()` performs type assertion to * the decoded value by combining with {@link assert} function. Therefore, when * the decoded value is not following the `T` type, {@link TypeGuardError} or * custom error generated by _errorFactory_ would be thrown. * * By the way, as URL query is not enough to express complex data structures, * `typia.http.assertQuery()` function has some limitations. If target type `T` * is notfollowing those restrictions, compilation errors would be occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 4. Union types are never allowed * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @param errorFactory Custom error factory. Default is `TypeGuardError` * @returns Decoded query object */ export declare function assertQuery<T extends object>(input: string | IReadableURLSearchParams, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Resolved<T>; /** * URL query decoder with type checking. * * `typia.http.isQuery()` is a function decoding a query string or an * `URLSearchParams` instance, with automatic type casting to the expected type. * When property type is defined as `boolean` or `number` type, * `typia.http.isQuery()` will cast the value to the expected type when * decoding. * * Also, after decoding, `typia.http.isQuery()` performs type checking to the * decoded value by combining with {@link is} function. Therefore, when the * decoded value is not following the `T` type, `null` value would be returned. * * By the way, as URL query is not enough to express complex data structures, * `typia.http.isQuery()` function has some limitations. If target type `T` is * notfollowing those restrictions, compilation errors would be occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 4. Union types are never allowed * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @returns Decoded query object or `null` value */ export declare function isQuery<T extends object>(input: string | IReadableURLSearchParams): Resolved<T> | null; /** * URL query decoder with type validation. * * `typia.http.validateQuery()` is a function decoding a query string or an * `URLSearchParams` instance, with automatic type casting to the expected type. * When property type is defined as `boolean` or `number` type, * `typia.http.validateQuery()` will cast the value to the expected type when * decoding. * * Also, after decoding, `typia.http.validateQuery()` performs type validation * to the decoded value by combining with {@link validate} function. Therefore, * when the decoded value is not following the `T` type, * {@link IValidation.IFailure} would be returned. Otherwise, * {@link IValidation.ISuccess} would be returned. * * By the way, as URL query is not enough to express complex data structures, * `typia.http.validateQuery()` function has some limitations. If target type * `T` is notfollowing those restrictions, compilation errors would be * occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 4. Union types are never allowed * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @returns Validation result with decoded query object */ export declare function validateQuery<T extends object>(input: string | IReadableURLSearchParams): IValidation<Resolved<T>>; /** * Headers decoder (for express and fastify). * * `typia.http.headers()` is a function decoding an header instance, with * automatic type casting to the expected type. When property type is defined as * `boolean` or `number` type, `typia.http.headers()` will cast the value to the * expected type. * * By the way, as HTTP headers are not enough to express complex data * structures, `typia.http.headers()` function has some limitations. If target * type `T` is not following those restrictions, compilation errors would be * occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Property key must be lower case * 4. Property value cannot be `null`, but `undefined` is possible * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 6. Union types are never allowed * 7. Property `set-cookie` must be array type * 8. Those properties cannot be array type * * - Age * - Authorization * - Content-length * - Content-type * - Etag * - Expires * - From * - Host * - If-modified-since * - If-unmodified-since * - Last-modified * - Location * - Max-forwards * - Proxy-authorization * - Referer * - Retry-after * - Server * - User-agent * * Also, `typia.http.headers()` function does not perform validation about the * decoded value. Therefore, if you can't sure that input data is following the * `T` type, it would better to call one of below functions instead. * * - {@link assertHeaders} * - {@link isHeaders} * - {@link validateHeaders} * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @returns Decoded headers object */ export declare function headers<T extends object>(input: Record<string, string | string[] | undefined>): Resolved<T>; /** * Headers decoder with type assertion (for express and fastify). * * `typia.http.assertHeaders()` is a function decoding an header instance, with * automatic type casting to the expected type. When property type is defined as * `boolean` or `number` type, `typia.http.headers()` will cast the value to the * expected type. * * Also, after decoding, `typia.http.assertHeaders()` performs type assertion to * the decoded value by combining with {@link assert} function. Therefore, when * the decoded value is not following the `T` type, {@link TypeGuardError} or * custom error generated by _errorFactory_ would be thrown. * * By the way, as HTTP headers are not enough to express complex data * structures, `typia.http.headers()` function has some limitations. If target * type `T` is not following those restrictions, compilation errors would be * occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Property key must be lower case * 4. Property value cannot be `null`, but `undefined` is possible * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 6. Union types are never allowed * 7. Property `set-cookie` must be array type * 8. Those properties cannot be array type * * - Age * - Authorization * - Content-length * - Content-type * - Etag * - Expires * - From * - Host * - If-modified-since * - If-unmodified-since * - Last-modified * - Location * - Max-forwards * - Proxy-authorization * - Referer * - Retry-after * - Server * - User-agent * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @param errorFactory Custom error factory. Default is `TypeGuardError` * @returns Decoded headers object */ export declare function assertHeaders<T extends object>(input: Record<string, string | string[] | undefined>, errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): Resolved<T>; /** * > You must configure the generic argument `T`. * * Headers decoder with type checking (for express and fastify). * * `typia.http.isHeaders()` is a function decoding an header instance, with * automatic type casting to the expected type. When property type is defined as * `boolean` or `number` type, `typia.http.headers()` will cast the value to the * expected type. * * Also, after decoding, `typia.http.isHeaders()` performs type checking to the * decoded value by combining with {@link is} function. Therefore, when the * decoded value is not following the `T` type, `null` value would be returned. * * By the way, as HTTP headers are not enough to express complex data * structures, `typia.http.headers()` function has some limitations. If target * type `T` is not following those restrictions, compilation errors would be * occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Property key must be lower case * 4. Property value cannot be `null`, but `undefined` is possible * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 6. Union types are never allowed * 7. Property `set-cookie` must be array type * 8. Those properties cannot be array type * * - Age * - Authorization * - Content-length * - Content-type * - Etag * - Expires * - From * - Host * - If-modified-since * - If-unmodified-since * - Last-modified * - Location * - Max-forwards * - Proxy-authorization * - Referer * - Retry-after * - Server * - User-agent * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @returns Decoded headers object or `null` value */ export declare function isHeaders<T extends object>(input: Record<string, string | string[] | undefined>): Resolved<T> | null; /** * Headers decoder with type validation (for express and fastify). * * `typia.http.validateHeaders()` is a function decoding an header instance, * with automatic type casting to the expected type. When property type is * defined as `boolean` or `number` type, `typia.http.headers()` will cast the * value to the expected type. * * Also, after decoding, `typia.http.validateHeaders()` performs type assertion * to the decoded value by combining with {@link validate} function. Therefore, * when the decoded value is not following the `T` type, * {@link IValidation.IError} would be returned. Otherwise, * {@link IValidation.ISuccess} be returned. * * By the way, as HTTP headers are not enough to express complex data * structures, `typia.http.headers()` function has some limitations. If target * type `T` is not following those restrictions, compilation errors would be * occurred. * * 1. Type `T` must be an object type * 2. Do not allow dynamic property * 3. Property key must be lower case * 4. Property value cannot be `null`, but `undefined` is possible * 5. Only `boolean`, `bigint`, `number`, `string` or their array types are allowed * 6. Union types are never allowed * 7. Property `set-cookie` must be array type * 8. Those properties cannot be array type * * - Age * - Authorization * - Content-length * - Content-type * - Etag * - Expires * - From * - Host * - If-modified-since * - If-unmodified-since * - Last-modified * - Location * - Max-forwards * - Proxy-authorization * - Referer * - Retry-after * - Server * - User-agent * * @author Jeongho Nam - https://github.com/samchon * @template T Expected type of decoded value * @param input Query string or URLSearchParams instance * @returns Decoded headers object */ export declare function validateHeaders<T extends object>(input: Record<string, string | string[] | undefined>): IValidation<Resolved<T>>; /** * URL path parameter decoder. * * `typia.http.parameter()` is a function decoding a path parameter, with * automatic type casting to the expected type. When type `T` has been defined * as `boolean` or `number` type, `typia.http.parameter()` will cast the value * to the expected type. * * Also, `typia.http.parameter()` performs type assertion to the decoded value * by combining with {@link assert} function. Therefore, when the decoded value * is not following the `T` type, {@link TypeGuardError} would be thrown. * * @template T Expected type of decoded value * @param input Path parameter string * @returns Decoded path parameter value */ export declare function parameter<T extends Atomic.Type | null>(input: string): Resolved<T>; /** * Creates a reusable {@link formdata} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createFormData(): never; /** * Creates a reusable {@link formdata} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @returns A reusable `formdata` function */ export declare function createFormData<T extends object>(): (input: FormData) => T; /** * Creates a reusable {@link assertFormData} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @param errorFactory Custom error factory. Default is `TypeGuardError` * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createAssertFormData(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never; /** * Creates a reusable {@link assertFormData} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @param errorFactory Custom error factory. Default is `TypeGuardError` * @returns A reusable `assertFormData` function */ export declare function createAssertFormData<T extends object>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: FormData) => T; /** * Creates a reusable {@link isFormData} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createIsFormData(): never; /** * Creates a reusable {@link isFormData} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @returns A reusable `isFormData` function */ export declare function createIsFormData<T extends object>(): (input: FormData) => T | null; /** * Creates a reusable {@link validateFormData} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createValidateFormData(): never; /** * Creates a reusable {@link validateFormData} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the formdata object * @returns A reusable `validateFormData` function */ export declare function createValidateFormData<T extends object>(): (input: FormData) => IValidation<Resolved<T>>; /** * Creates a reusable {@link query} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createQuery(): never; /** * Creates a reusable {@link query} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @returns A reusable `query` function */ export declare function createQuery<T extends object>(): (input: string | IReadableURLSearchParams) => T; /** * Creates a reusable {@link assertQuery} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @param errorFactory Custom error factory. Default is `TypeGuardError` * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createAssertQuery(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never; /** * Creates a reusable {@link assertQuery} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @param errorFactory Custom error factory. Default is `TypeGuardError` * @returns A reusable `assertQuery` function */ export declare function createAssertQuery<T extends object>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: string | IReadableURLSearchParams) => T; /** * Creates a reusable {@link isQuery} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createIsQuery(): never; /** * Creates a reusable {@link isQuery} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @returns A reusable `isQuery` function */ export declare function createIsQuery<T extends object>(): (input: string | IReadableURLSearchParams) => T | null; /** * Creates a reusable {@link validateQuery} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createValidateQuery(): never; /** * Creates a reusable {@link validateQuery} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the query object * @returns A reusable `validateQuery` function */ export declare function createValidateQuery<T extends object>(): (input: string | IReadableURLSearchParams) => IValidation<Resolved<T>>; /** * Creates a reusable {@link headers} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createHeaders(): never; /** * Creates a reusable {@link headers} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @returns A reusable `headers` function */ export declare function createHeaders<T extends object>(): (input: Record<string, string | string[] | undefined>) => T; /** * Creates a reusable {@link assertHeaders} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @param errorFactory Custom error factory. Default is `TypeGuardError` * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createAssertHeaders(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): never; /** * Creates a reusable {@link assertHeaders} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @param errorFactory Custom error factory. Default is `TypeGuardError` * @returns A reusable `assertHeaders` function */ export declare function createAssertHeaders<T extends object>(errorFactory?: undefined | ((props: TypeGuardError.IProps) => Error)): (input: Record<string, string | string[] | undefined>) => T; /** * Creates a reusable {@link isHeaders} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createIsHeaders(): never; /** * Creates a reusable {@link isHeaders} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @returns A reusable `isHeaders` function */ export declare function createIsHeaders<T extends object>(): (input: Record<string, string | string[] | undefined>) => T | null; /** * Creates a reusable {@link validateHeaders} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createValidateHeaders(): never; /** * Creates a reusable {@link validateHeaders} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the headers object * @returns A reusable `validateHeaders` function */ export declare function createValidateHeaders<T extends object>(): (input: Record<string, string | string[] | undefined>) => IValidation<Resolved<T>>; /** * Creates a reusable {@link parameter} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the parameter value * @throws Compile error * @danger You must configure the generic argument `T` */ export declare function createParameter(): never; /** * Creates a reusable {@link parameter} function. * * @author Jeongho Nam - https://github.com/samchon * @template T The type of the parameter value * @returns A reusable `parameter` function */ export declare function createParameter<T extends Atomic.Type | null>(): (input: string) => T;