StringSchema
Generated by TypeDoc. Do not edit this page directly.
Class: StringSchema
Section titled “Class: StringSchema”Defined in: packages/core/src/schema/index.ts:137
Extends
Section titled “Extends”Schema<unknown,string>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new StringSchema(): StringSchema;Returns
Section titled “Returns”StringSchema
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”| Property | Modifier | Type | Default value | Inherited from | Defined in |
|---|---|---|---|---|---|
isHarnessSchema | readonly | true | true | Schema.isHarnessSchema | packages/core/src/schema/index.ts:76 |
Methods
Section titled “Methods”default()
Section titled “default()”default(value): DefaultSchema<unknown, string>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | string | (() => string) |
Returns
Section titled “Returns”DefaultSchema<unknown, string>
Inherited from
Section titled “Inherited from”describe()
Section titled “describe()”describe(description): this;Defined in: packages/core/src/schema/index.ts:96
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
description | string |
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”max(length): this;Defined in: packages/core/src/schema/index.ts:146
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
length | number |
Returns
Section titled “Returns”this
min(length): this;Defined in: packages/core/src/schema/index.ts:141
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
length | number |
Returns
Section titled “Returns”this
optional()
Section titled “optional()”optional(): OptionalSchema<unknown, string | undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<unknown, string | undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): string;Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<string>;Defined in: packages/core/src/schema/index.ts:151
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<string>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:162