Creates a new RecordShape instance.
The shape of record keys.
The shape of record values.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
Protected_The issue options or the issue message.
The dictionary of shape annotations.
ReadonlyinputsThe array of unique input types and values that are accepted by the shape.
Readonlyistrue if the shape allows only Shape.parseAsync and throws an error if Shape.parse is called, or
false if the shape can be used in both sync and async contexts.
ReadonlykeysThe shape of record keys.
The array of operations that are applied to the shape output.
ReadonlyvaluesThe shape of record values.
Protected_Synchronously parses the input.
The shape input to parse.
Parsing options.
null if input matches the output, Ok that wraps the output, or an array of captured issues.
Protected_Asynchronously parses the input.
The shape input to parse.
Parsing options.
The globally unique number that identifies the parsing process.
null if input matches the output, Ok that wraps the output, or an array of captured issues.
Protected_The callback that applies Shape.operations to the shape output value.
This method returns a promise if there are async Shape.operations.
If the shape overrides only Shape._apply and doesn't override Shape._applyAsync then it's only safe to call this method as the last statement in Shape._apply. Otherwise, it may return an unexpected promise.
If the shape overrides both Shape._apply and Shape._applyAsync then this method would always synchronously return a Result inside Shape._apply.
Protected_Protected_Returns input types and literal values that this shape can accept as an input.
Protected_Must return true if the shape must be used in async context only, otherwise the shape can be used in both sync
and async contexts. Override this method to implement a custom shape.
Returns true if the shape accepts given input type or value, or false otherwise.
The type or value that must be checked.
Adds an asynchronous operation to the shape.
The param that is passed to the operation when it is applied.
The callback that asynchronously applies an operation to the shape output value.
Optionaloptions: ParameterizedOperationOptions<Param>The operation options.
The clone of the shape.
Adds an asynchronous operation to the shape.
The callback that asynchronously applies an operation to the shape output value.
Optionaloptions: OperationOptionsThe operation options.
The clone of the shape.
Adds a synchronous operation to the shape.
The param that is passed to the operation when it is applied.
The callback that synchronously applies an operation to the shape output value.
Optionaloptions: ParameterizedOperationOptions<Param>The operation options.
The clone of the shape.
Adds a synchronous operation to the shape.
The callback that synchronously applies an operation to the shape output value.
Optionaloptions: OperationOptionsThe operation options.
The clone of the shape.
Allows an input value, so it is passed directly to the output.
The allowed value.
The allowed value.
Adds a synchronous operation that alters the output value without changing its type.
If you want to change the base type, consider using Shape.convert.
The param that is passed to the operation when it is applied.
The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
The operation options.
The clone of the shape.
Adds a synchronous operation that alters the output value without changing its type.
If you want to change the base type, consider using Shape.convert.
The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
Optionaloptions: OperationOptionsThe operation options.
The clone of the shape.
Adds an asynchronous operation that alters the output value without changing its type.
If you want to change the base type, consider using Shape.convertAsync.
The param that is passed to the operation when it is applied.
The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
The operation options.
The clone of the shape.
Adds an asynchronous operation that alters the output value without changing its type.
If you want to change the base type, consider using Shape.convertAsync.
The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
Optionaloptions: OperationOptionsThe operation options.
The clone of the shape.
Adds annotations to the shape.
Annotations to add.
The clone of the shape with the updated annotations.
Returns a sub-shape that describes a value associated with the given property name, or null if there's no such
sub-shape.
The sub-shape or null if there's no such key in the shape.
Returns a shape that adds a brand to the output type.
The brand value.
A shape with the branded output type.
Returns undefined if parsing fails.
Returns the fallback value if parsing fails.
The fallback value.
The value or a callback that returns a value that is returned if parsing has failed. A callback receives an input value, an array of raised issues, and parsing options.
Adds a synchronous operation that checks that the shape output satisfies a requirement.
The callback must return null or undefined if value is valid, or an issue or an array of issues
if value is invalid. If a callback returns an empty array, it is considered that no issues have occurred.
The param that is passed to the operation when it is applied.
The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
The operation options.
The clone of the shape.
Adds a synchronous operation that checks that the shape output satisfies a requirement.
The callback must return null or undefined if value is valid, or an issue or an array of issues
if value is invalid. If a callback returns an empty array, it is considered that no issues have occurred.
The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
Optionaloptions: OperationOptionsThe operation options.
The clone of the shape.
Adds an asynchronous operation that checks that the shape output satisfies a requirement.
The callback must return a promise that is resolved with null or undefined if value is valid, or an
issue or an array of issues if value is invalid. If promise resolves with an empty array, it is
considered that no issues have occurred.
The param that is passed to the operation when it is applied.
The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
The operation options.
The clone of the shape.
Adds an asynchronous operation that checks that the shape output satisfies a requirement.
The callback must return a promise that is resolved with null or undefined if value is valid, or an
issue or an array of issues if value is invalid. If promise resolves with an empty array, it is
considered that no issues have occurred.
The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
Optionaloptions: OperationOptionsThe operation options.
The clone of the shape.
Synchronously converts the output value of the shape.
If you want to don't want to change the base type, consider using Shape.alter.
The value returned from the callback that converts the output value of this shape.
The callback that converts the input value. Throw a ValidationError to notify that the conversion cannot be successfully completed.
The ConvertShape instance.
Asynchronously converts the output value of the shape.
If you want to don't want to change the base type, consider using Shape.alterAsync.
The value returned from the callback that converts the output value of this shape.
The callback that converts the input value asynchronously. The returned promise can be rejected with a ValidationError to notify that the conversion cannot be successfully completed.
The ConvertShape instance.
Converts the shape and its child shapes to deep partial alternatives.
Note: This method returns a shape without any operations.
The deep partial clone of the shape.
Excludes value from both input and output.
The denied value.
The excluded value.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
Checks that the input doesn't match the shape.
The shape to which the output must not conform.
The shape to which the output must not conform.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
Prevents an input and output from being undefined.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
Checks that the input doesn't match the shape.
This method works exactly as Shape.exclude at runtime, but it doesn't perform the exclusion on the type level.
The shape to which the output must not conform.
The shape to which the output must not conform.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
Replaces null input value with an null output value.
Replaces null input value with a default output value.
The value that is used as the replacement for null.
The value that should be used if an input value is null.
Passes null and undefined input values directly to the output without parsing.
Replaces null and undefined input value with a default output value.
The value that is used as the replacement for undefined and null.
OptionaldefaultValue: DefaultValueThe value that should be used if an input value is undefined or null.
Replaces undefined input value with an undefined output value.
Replaces undefined input value with a default output value.
The value that is used as the replacement for undefined.
The value that should be used if an input value is undefined.
Synchronously parses the value.
The value to parse.
Optionaloptions: ParseOptionsParsing options.
The value that conforms the output type of the shape.
Error if the shape doesn't support the sync parsing, see Shape.isAsync.
ValidationError if any issues occur during parsing.
Asynchronously parses the value.
The value to parse.
Optionaloptions: ParseOptionsParsing options.
The promise that resolves with the value that conforms the output type of the shape, or rejects with a ValidationError if any issues occur during parsing.
Synchronously parses the value and returns undefined if parsing fails.
The value to parse.
The value that conforms the output type of the shape.
Error if the shape doesn't support the sync parsing, see Shape.isAsync.
Synchronously parses the value and returns the default value if parsing fails.
The default value that is returned if parsing fails.
The value to parse.
The default value that is returned if parsing fails.
Optionaloptions: ParseOptionsParsing options.
The value that conforms the output type of the shape.
Error if the shape doesn't support the sync parsing, see Shape.isAsync.
Asynchronously parses the value and returns undefined value if parsing fails.
The value to parse.
The value that conforms the output type of the shape.
Asynchronously parses the value and returns the default value if parsing fails.
The default value that is returned if parsing fails.
The value to parse.
The default value that is returned if parsing fails.
Optionaloptions: ParseOptionsParsing options.
The value that conforms the output type of the shape.
Makes a record readonly: properties cannot be added, removed or updated at runtime.
Adds a synchronous operation that refines the shape output type with the narrowing predicate.
The narrowed output value.
The param that is passed to the operation when it is applied.
The predicate that returns true if the value conforms the required type, or false otherwise.
The operation options or the issue message.
The shape with the narrowed output.
Adds a synchronous operation that refines the shape output type with the narrowing predicate.
The narrowed output value.
The predicate that returns true if the value conforms the required type, or false otherwise.
Optionaloptions: Message | RefineOptionsThe operation options or the issue message.
The shape with the narrowed output.
Adds a synchronous operation that checks that the output value conforms the predicate.
The param that is passed to the operation when it is applied.
The predicate that returns truthy result if the value is valid, or returns falsy result otherwise.
Optionaloptions: Message | ParameterizedRefineOptions<Param>The operation options or the issue message.
The clone of the shape.
Adds a synchronous operation that checks that the output value conforms the predicate.
The predicate that returns truthy result if the value is valid, or returns falsy result otherwise.
Optionaloptions: Message | RefineOptionsThe operation options or the issue message.
The clone of the shape.
Adds an asynchronous operation that checks that the output value conforms the predicate.
The param that is passed to the operation when it is applied.
The predicate that returns a promise that resolves with a truthy result if the value is valid, or a falsy result otherwise.
Optionaloptions: Message | ParameterizedRefineOptions<Param>The operation options or the issue message.
The clone of the shape.
Adds an asynchronous operation that checks that the output value conforms the predicate.
The predicate that returns a promise that resolves with a truthy result if the value is valid, or a falsy result otherwise.
Optionaloptions: Message | RefineOptionsThe operation options or the issue message.
The clone of the shape.
Replaces an input value with an output value.
The input value to replace.
The output value that is returned if an inputValue is received.
Pipes the output of this shape to the input of another shape.
The output value.
The shape that validates the output if this shape.
The value to parse.
Optionaloptions: ParseOptionsParsing options.
The Ok instance if parsing has succeeded or Err if parsing has failed.
Error if the shape doesn't support the sync parsing, see Shape.isAsync.
The value to parse.
Optionaloptions: ParseOptionsParsing options.
The Ok instance if parsing has succeeded or Err if parsing has failed.
Defines an all-or-nothing relationship between keys where if one of the keys is present, all of them are required as well.
The keys of which, if one present, all are required.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
The clone of the shape.
Defines a relationship between keys where not all peers can be present at the same time.
The keys of which, if one present, the others may not all be present.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
The clone of the shape.
Defines a relationship between keys where at least one of the keys is required (and more than one is allowed).
The keys of which at least one must appear.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
The clone of the shape.
Defines an exclusive relationship between a set of keys where only one is allowed but none are required.
The exclusive keys that must not appear together but where none are required.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
The clone of the shape.
Constrains a record to have a null or Object prototype.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
The clone of the shape.
Defines an exclusive relationship between a set of keys where one of them is required but not at the same time.
The exclusive keys that must not appear together but where one of them is required.
Optionaloptions: IssueOptions | MessageThe issue options or the issue message.
The clone of the shape.
The shape that describes an object with string keys and values that conform the given shape.