Directus / @directus/sdk / rest / createCollection

Function: createCollection() ​

createCollection<Schema, TQuery>(item, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, FieldsWildcard<DirectusCollection<Schema>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof DirectusCollection<Schema> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Defined in: rest/commands/create/collections.ts:20

Create a new Collection. This will create a new table in the database as well.

Type Parameters ​

• Schema

• TQuery extends Query<Schema, DirectusCollection<Schema>>

Parameters ​

item ​

This endpoint doesn't currently support any query parameters.

collection? ​

string

fields? ​

object[]

meta? ​

NestedUnion<IfAny<Schema, { accountability: null | string; archive_app_filter: boolean; archive_field: null | string; archive_value: null | string; collapse: string; collection: string; color: null | string; display_template: null | string; group: null | string; hidden: boolean; icon: null | string; item_duplication_fields: null | string[]; note: null | string; preview_url: null | string; singleton: boolean; sort: null | number; sort_field: null | string; translations: null | CollectionMetaTranslationType[]; unarchive_value: null | string; versioning: boolean; }, "directus_collections" extends keyof Schema ? UnpackList<Schema[keyof Schema & "directus_collections"]> extends Item ? { [Field in string | number | symbol]: Item[Field] } & object : never : object>>

schema? ​

null | { [key: string]: unknown; comment: null | string; name: string; }

query? ​

TQuery

Optional return data query

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, DirectusCollection<Schema>> extends FF ? MapFlatFields<DirectusCollection<Schema>, FieldsWildcard<DirectusCollection<Schema>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof DirectusCollection<Schema> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

The collection object for the collection created in this request.