Directus / @directus/sdk / rest / createItem

Function: createItem() ​

createItem<Schema, Collection, TQuery>(collection, item, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>>, 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 UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Defined in: rest/commands/create/items.ts:51

Create a new item in the given collection.

Type Parameters ​

• Schema

• Collection extends string | number | symbol

• TQuery extends Query<Schema, Schema[Collection]>

Parameters ​

collection ​

Collection

The collection of the item

item ​

Partial<UnpackList<Schema[Collection]>>

The item to create

query? ​

TQuery

Optional return data query

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, any, Collection extends keyof (...) ? (...) extends (...) ? (...) : (...) : never>>, FieldsWildcard<UnpackList<IfAny<Schema, any, (...) extends (...) ? (...) : (...)>>, 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 UnpackList<IfAny<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>

Returns the item objects of the item that were created.