Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
56 lines
2.3 KiB
Plaintext
56 lines
2.3 KiB
Plaintext
/** The Standard Schema interface. */
|
|
export interface StandardSchemaV1<Input = unknown, Output = Input> {
|
|
/** The Standard Schema properties. */
|
|
readonly "~standard": StandardSchemaV1.Props<Input, Output>;
|
|
}
|
|
export declare namespace StandardSchemaV1 {
|
|
/** The Standard Schema properties interface. */
|
|
interface Props<Input = unknown, Output = Input> {
|
|
/** The version number of the standard. */
|
|
readonly version: 1;
|
|
/** The vendor name of the schema library. */
|
|
readonly vendor: string;
|
|
/** Validates unknown input values. */
|
|
readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
|
|
/** Inferred types associated with the schema. */
|
|
readonly types?: Types<Input, Output> | undefined;
|
|
}
|
|
/** The result interface of the validate function. */
|
|
type Result<Output> = SuccessResult<Output> | FailureResult;
|
|
/** The result interface if validation succeeds. */
|
|
interface SuccessResult<Output> {
|
|
/** The typed output value. */
|
|
readonly value: Output;
|
|
/** The non-existent issues. */
|
|
readonly issues?: undefined;
|
|
}
|
|
/** The result interface if validation fails. */
|
|
interface FailureResult {
|
|
/** The issues of failed validation. */
|
|
readonly issues: ReadonlyArray<Issue>;
|
|
}
|
|
/** The issue interface of the failure output. */
|
|
interface Issue {
|
|
/** The error message of the issue. */
|
|
readonly message: string;
|
|
/** The path of the issue, if any. */
|
|
readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
|
|
}
|
|
/** The path segment interface of the issue. */
|
|
interface PathSegment {
|
|
/** The key representing a path segment. */
|
|
readonly key: PropertyKey;
|
|
}
|
|
/** The Standard Schema types interface. */
|
|
interface Types<Input = unknown, Output = Input> {
|
|
/** The input type of the schema. */
|
|
readonly input: Input;
|
|
/** The output type of the schema. */
|
|
readonly output: Output;
|
|
}
|
|
/** Infers the input type of a Standard Schema. */
|
|
type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["input"];
|
|
/** Infers the output type of a Standard Schema. */
|
|
type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema["~standard"]["types"]>["output"];
|
|
}
|