OasIntersection
OasIntersection is an object representing an intersection type as expressed in OpenAPI as allOf.
Properties
| Property | Type | Description |
|---|---|---|
| oasType | 'schema' | Static value representing the OpenAPI intersection type. |
| type | 'intersection' | Static value indicating intersection type. |
| title | string | undefined | Optional title of the intersection type. |
| description | string | undefined | Optional description of the intersection type. |
| nullable | boolean | undefined | Optional flag indicating if the intersection type is nullable. |
| example | unknown | undefined | Optional example value for the intersection type. |
| members | OasSchema | OasRef<'schema'> | Intersection members types. |
| 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. |
Methods
isRef
Returns false indicating that the intersection is not a reference.
intersection.isRef()
Return value
false
resolve
Returns the intersection object itself.
intersection.resolve()
Return value
The intersection object itself.
resolveOnce
Returns the intersection object itself.
intersection.resolveOnce()
Return value
The intersection object itself.