tsukiko • Docs
tsukiko / StringParser
Represents a parser for string values with various validation options.
Parser<string>
new StringParser():
StringParser
Creates a new instance of StringParser.
protectedoptionaldefaultValue:string
protectedisOptional:boolean=false
protectedlangType:langType=DEFAULT_LANG
protectedrules:ParserFunction[]
check(
input):input is string
Checks if the input is valid according to the parser's rules.
• input: unknown
The input to check.
input is string
True if the input is valid, false otherwise.
default(
value):Parser<string>
Sets a default value for the parser.
• value: string
The default value.
Parser<string>
The current Parser instance.
protecteddefaultHandle(input):string
• input: string
string
describe(
description):StringParser
Sets a description for the parser.
• description: string
The description to set.
The current Parser instance.
domain():
StringParser
Sets the parser to validate domain names.
The current StringParser instance.
email():
StringParser
Sets the parser to validate email addresses.
The current StringParser instance.
empty():
StringParser
Configures the parser to allow undefined but not null.
The current Parser instance.
endsWith(
ends):StringParser
Sets a suffix that the string must end with.
• ends: string
The suffix string.
The current StringParser instance.
protectederror(lang,data?):TsuError
• lang: "not_string" | "not_a_email" | "not_a_domain" | "not_a_url" | "illegal_match_string" | "illegal_starts_with" | "illegal_ends_with" | "too_long" | "too_short" | "not_number" | "not_integer_number" | "not_odd_number" | "not_even_number" | "not_natural_number" | "not_positive_number" | "not_negative_number" | "not_percentage" | "too_bigger" | "too_bigger_has" | "too_smaller" | "too_smaller_has" | "not_multiple_number" | "is_a_NaN" | "not_boolean" | "not_true" | "not_false" | "not_null" | "not_undefined" | "not_never" | "not_an_array" | "array_error" | "too_many_items" | "too_few_items" | "not_a_tuple" | "illegal_tuple_length" | "tuple_error" | "not_an_object" | "object_is_null" | "object_is_an_array" | "object_not_instance_of_constructor" | "object_keys_too_many" | "object_keys_too_few" | "object_error" | "object_key_error" | "intersection_error" | "union_error" | "literal_only" | "literal_number_error" | "literal_string_error" | "literal_boolean_error" | "custom_error" | "not_a_function" | "not_a_constructor" | "not_an_async_function" | "not_a_generator_function" | "not_an_async_generator_function" | "not_an_arrow_function" | "function_args_count_mismatch" | "function_name_mismatch" | "not_a_class" | "class_args_count_mismatch" | "class_name_mismatch" | "class_prototype_error"
• data?
lang(
value):StringParser
• value: langType = DEFAULT_LANG
max(
value):StringParser
Sets the maximum length for the string.
• value: number
The maximum length.
The current StringParser instance.
min(
value):StringParser
Sets the minimum length for the string.
• value: number
The minimum length.
The current StringParser instance.
optional():
Parser<undefined|string>
Makes the parser optional.
Parser<undefined | string>
The current Parser instance.
parse(
input):string
Parses the input and returns the result.
• input: unknown
The input to parse.
string
The parsed result.
If parsing fails.
parseAsync(
input):Promise<unknown>
Asynchronously parses the input.
• input: unknown
The input to parse.
Promise<unknown>
A promise that resolves with the parsed result or rejects with an error.
parseSafe(
input):ParserSafeReturn<string>
Safely parses the input and returns a result object.
• input: unknown
The input to parse.
ParserSafeReturn<string>
An object containing the parsing result or error.
regexp(
pattern):StringParser
Sets a regular expression pattern for string validation.
• pattern: RegExp
The regular expression to use for validation.
The current StringParser instance.
schema(
bringSchema):JsonSchema
Generates a JSON schema for the parser.
• bringSchema: boolean = true
Whether to include the $schema property. Defaults to true.
The generated JSON schema.
protectedsetMeta(metadata):void
• metadata: Partial<SchemaMetadata>
void
startsWith(
starts):StringParser
Sets a prefix that the string must start with.
• starts: string
The prefix string.
The current StringParser instance.
strict(
isStrict):StringParser
Sets whether the parser should be strict in its type checking.
• isStrict: boolean = true
Whether to enable strict mode. Defaults to true.
The current StringParser instance.
title(
title):StringParser
Sets a title for the parser.
• title: string
The title to set.
The current Parser instance.
url():
StringParser
Sets the parser to validate URLs.
The current StringParser instance.