shelving/schema/SlugSchema.d.ts

Toolkit for using data in JavaScript.

import { StringSchema, type StringSchemaOptions } from "./StringSchema.js";
/**
 * Define a valid slug, e.g. `this-is-a-slug`
 *
 * - Useful for URL components, usernames, etc.
 * - Minimum slug length is 2 characters.
 * - Maximum slug length is 64 characters.
 */
export declare class SlugSchema extends StringSchema {
    constructor(options: Omit<StringSchemaOptions, "min" | "max" | "multiline">);
    sanitize(str: string): string;
}
/** Valid slug, e.g. `this-is-a-slug` */
export declare const SLUG: SlugSchema;
/** Valid slug, e.g. `this-is-a-slug`, or `null` */
export declare const OPTIONAL_SLUG: import("./OptionalSchema.js").OptionalSchema<string>;