Class SchemaDataBuilder<Resource>

Type parameters

Resource = unknown

Hierarchy

SchemaDataBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

attributes

attributes(handler?: SerializeHandler<Dictionary<unknown>> | AllowDeny<Resource>): SchemaDataBuilder<Resource>

- Defined in src/schema-data-builder.ts:157
Parameters
- Optional handler: SerializeHandler<Dictionary<unknown>> | AllowDeny<Resource>
Returns SchemaDataBuilder<Resource>

build

build(): SchemaData

- Defined in src/schema-data-builder.ts:136
Returns SchemaData

id

id(handler: SerializeHandler<string>): SchemaDataBuilder<Resource>

- Defined in src/schema-data-builder.ts:147
Parameters
- handler: SerializeHandler<string>
Returns SchemaDataBuilder<Resource>

relationships

relationships(relationships: Dictionary<SerializeRelationshipsHandler>): SchemaDataBuilder<Resource>

- Defined in src/schema-data-builder.ts:178
Parameters
- relationships: Dictionary<SerializeRelationshipsHandler>
Returns SchemaDataBuilder<Resource>

type

type(handler: SerializeHandler<string>): SchemaDataBuilder<Resource>

- Defined in src/schema-data-builder.ts:152
Parameters
- handler: SerializeHandler<string>
Returns SchemaDataBuilder<Resource>

untransformAttributes

untransformAttributes(handler?: AllowDeny<Resource> | DeserializeHandler<Dictionary<unknown>>): SchemaDataBuilder<Resource>

- Defined in src/schema-data-builder.ts:166
Parameters
- Optional handler: AllowDeny<Resource> | DeserializeHandler<Dictionary<unknown>>
Returns SchemaDataBuilder<Resource>

Static includeBelongsToRelationship

includeBelongsToRelationship(params: SerializeRelationshipsDataParams, field: string, resource: string, options?: { allowNull?: boolean; included?: boolean }): undefined | Relationship

- Defined in src/schema-data-builder.ts:70
Parameters
- params: SerializeRelationshipsDataParams
- field: string
- resource: string
- Optional options: { allowNull?: boolean; included?: boolean }
  - Optional allowNull?: boolean
  - Optional included?: boolean
Returns undefined | Relationship

Static includeHasManyRelationship

includeHasManyRelationship(params: SerializeRelationshipsDataParams, field: string, resource: string, options?: { included?: boolean }): undefined | Relationship

- Defined in src/schema-data-builder.ts:49
Parameters
- params: SerializeRelationshipsDataParams
- field: string
- resource: string
- Optional options: { included?: boolean }
  - Optional included?: boolean
Returns undefined | Relationship

Static linkToBelongsToRelationship

linkToBelongsToRelationship(params: SerializeRelationshipsDataParams, relatedIdPath: string, resource: string, linkMeta?: Dictionary<unknown>): undefined | Relationship

- Defined in src/schema-data-builder.ts:89
Parameters
- params: SerializeRelationshipsDataParams
- relatedIdPath: string
- resource: string
- Optional linkMeta: Dictionary<unknown>
Returns undefined | Relationship

Static linkToHasManyRelationship

linkToHasManyRelationship(params: SerializeRelationshipsDataParams, parentResource: string, relatedResource: string, linkMeta?: Dictionary<unknown>): Relationship

- Defined in src/schema-data-builder.ts:116
Parameters
- params: SerializeRelationshipsDataParams
- parentResource: string
- relatedResource: string
- Optional linkMeta: Dictionary<unknown>
Returns Relationship

Static mergeRelationships

mergeRelationships(...relationships: (undefined | Relationship)[]): undefined | Relationship

- Defined in src/schema-data-builder.ts:131
Parameters
- Rest ...relationships: (undefined | Relationship)[]
Returns undefined | Relationship

Generated using TypeDoc