OasString

OasString is an object representing an OpenAPI string schema.

Properties

Property	Type	Description
oasType	`'schema'`	Static value representing the OpenAPI schema type.
type	`'string'`	Static value representing the OpenAPI string schema type.
title	`string \| undefined`	Optional title of the string.
description	`string \| undefined`	Optional description of the string.
format	`string \| undefined`	Optional format of the string.
enums	`string[] \| undefined`	Optional array of allowed string values.
nullable	`boolean \| undefined`	Optional flag indicating whether the string can be `null`.
example	`string \| undefined`	Optional example value for the string.
extensionFields	`Record<string, unknown> \| undefined`	Optional map of custom fields defined by OpenAPI extensions. Keys are strings beginning with `x-` and values are of any valid JSON type.

Returns false indicating that the string is not a reference.

string.isRef()

Return value

false

Returns the string itself.

string.resolve()

Return value

The string itself.

Returns the string itself.

string.resolveOnce()

**Return value**

The string itself.