Class SchemaBuilder<Resource>

Type parameters

Resource = unknown

Hierarchy

SchemaBuilder

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SchemaBuilder<Resource>(resourceName: string): SchemaBuilder<Resource>

- Defined in src/schema-builder.ts:8
Type parameters
- Resource = unknown
Parameters
- resourceName: string
Returns SchemaBuilder<Resource>

Properties

Readonly dataBuilder

dataBuilder: SchemaDataBuilder<Resource>

Readonly resourceName

resourceName: string

Methods

build

build(): Schema

- Defined in src/schema-builder.ts:12
Returns Schema

data

data(schemaData: SchemaData): SchemaBuilder<Resource>

- Defined in src/schema-builder.ts:31
Parameters
- schemaData: SchemaData
Returns SchemaBuilder<Resource>

links

links(handler: (params: DocParams) => unknown): SchemaBuilder<Resource>

- Defined in src/schema-builder.ts:21
Parameters
- handler: (params: DocParams) => unknown
  - - (params: DocParams): unknown
    - Parameters
      - params: DocParams
      Returns unknown
Returns SchemaBuilder<Resource>

meta

meta(handler: (params: DocParams) => unknown): SchemaBuilder<Resource>

- Defined in src/schema-builder.ts:26
Parameters
- handler: (params: DocParams) => unknown
  - - (params: DocParams): unknown
    - Parameters
      - params: DocParams
      Returns unknown
Returns SchemaBuilder<Resource>

Generated using TypeDoc