Class CollectionBuilder<TName, TRow, TKey, TChildren, TApi>

Type Parameters

TName extends string
TRow extends object
TKey extends string
TChildren extends CollectionDefinitions
TApi extends ApiDefinitions

Index

Constructors

constructor

Methods

api children key schema toDefinition

Constructors

constructor

new CollectionBuilder<
    TName extends string,
    TRow extends object,
    TKey extends string,
    TChildren extends CollectionDefinitions,
    TApi extends ApiDefinitions,
>(
    state: CollectionBuilderState,
): CollectionBuilder<TName, TRow, TKey, TChildren, TApi>
Type Parameters
- TName extends string
- TRow extends object
- TKey extends string
- TChildren extends CollectionDefinitions
- TApi extends ApiDefinitions
Parameters
- state: CollectionBuilderState
Returns CollectionBuilder<TName, TRow, TKey, TChildren, TApi>
- Defined in packages/definition/src/index.ts:99

Methods

api

api<TApiName extends string, TBuilder extends ApiBuilder<any, any>>(
    name: TApiName,
    configure: (api: ApiBuilder<undefined, unknown>) => TBuilder,
): CollectionBuilder<
    TName,
    TRow,
    TKey,
    TChildren,
    TApi & Record<TApiName, ApiFromBuilder<TBuilder>>,
>
Type Parameters
- TApiName extends string
- TBuilder extends ApiBuilder<any, any>
Parameters
- name: TApiName
- configure: (api: ApiBuilder<undefined, unknown>) => TBuilder
Returns CollectionBuilder<
    TName,
    TRow,
    TKey,
    TChildren,
    TApi & Record<TApiName, ApiFromBuilder<TBuilder>>,
>
- Defined in packages/definition/src/index.ts:113

children

children<TBuilder extends CollectionsBuilder<any>>(
configure: (children: CollectionsBuilder<{}>) => TBuilder,
): CollectionBuilder<TName, TRow, TKey, BuilderCollections<TBuilder>, TApi>
Type Parameters
- TBuilder extends CollectionsBuilder<any>
Parameters
- configure: (children: CollectionsBuilder<{}>) => TBuilder
Returns CollectionBuilder<TName, TRow, TKey, BuilderCollections<TBuilder>, TApi>
- Defined in packages/definition/src/index.ts:139

key

key<TKeyNext extends string>(
key: TKeyNext,
): CollectionBuilder<TName, TRow, TKeyNext, TChildren, TApi>
Type Parameters
- TKeyNext extends string
Parameters
- key: TKeyNext
Returns CollectionBuilder<TName, TRow, TKeyNext, TChildren, TApi>
- Defined in packages/definition/src/index.ts:107

schema

schema<TNextSchema extends StandardSchemaV1<unknown, unknown>>(
    schema: TNextSchema,
): CollectionBuilder<
    TName,
    Extract<SchemaOutput<TNextSchema>, object>,
    never,
    TChildren,
    TApi,
>
Type Parameters
- TNextSchema extends StandardSchemaV1<unknown, unknown>
Parameters
- schema: TNextSchema
Returns CollectionBuilder<
    TName,
    Extract<SchemaOutput<TNextSchema>, object>,
    never,
    TChildren,
    TApi,
>
- Defined in packages/definition/src/index.ts:101

toDefinition

toDefinition(
parentPath: string,
parentName: string | undefined,
): CollectionDefinition<TRow>
Parameters
- parentPath: string
- parentName: string | undefined
Returns CollectionDefinition<TRow>
- Defined in packages/definition/src/index.ts:148

Class CollectionBuilder<TName, TRow, TKey, TChildren, TApi>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CollectionBuilder<TName, TRow, TKey, TChildren, TApi>

Methods

api

Type Parameters

Parameters

Returns CollectionBuilder<
    TName,
    TRow,
    TKey,
    TChildren,
    TApi & Record<TApiName, ApiFromBuilder<TBuilder>>,
>

children

Type Parameters

Parameters

Returns CollectionBuilder<TName, TRow, TKey, BuilderCollections<TBuilder>, TApi>

key

Type Parameters

Parameters

Returns CollectionBuilder<TName, TRow, TKeyNext, TChildren, TApi>

schema

Type Parameters

Parameters

Returns CollectionBuilder<
    TName,
    Extract<SchemaOutput<TNextSchema>, object>,
    never,
    TChildren,
    TApi,
>

toDefinition

Parameters

Returns CollectionDefinition<TRow>

Settings

On This Page

Class CollectionBuilder<TName, TRow, TKey, TChildren, TApi>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CollectionBuilder<TName, TRow, TKey, TChildren, TApi>

Methods

api

Type Parameters

Parameters

Returns CollectionBuilder< TName, TRow, TKey, TChildren, TApi & Record<TApiName, ApiFromBuilder<TBuilder>>,>

children

Type Parameters

Parameters

Returns CollectionBuilder<TName, TRow, TKey, BuilderCollections<TBuilder>, TApi>

key

Type Parameters

Parameters

Returns CollectionBuilder<TName, TRow, TKeyNext, TChildren, TApi>

schema

Type Parameters

Parameters

Returns CollectionBuilder< TName, Extract<SchemaOutput<TNextSchema>, object>, never, TChildren, TApi,>

toDefinition

Parameters

Returns CollectionDefinition<TRow>

Settings

On This Page

Returns CollectionBuilder<
TName,
TRow,
TKey,
TChildren,
TApi & Record<TApiName, ApiFromBuilder<TBuilder>>,
>

Returns CollectionBuilder<
TName,
Extract<SchemaOutput<TNextSchema>, object>,
never,
TChildren,
TApi,
>