Directus / @directus/sdk / rest / createShare

Function: createShare() ​

createShare<Schema, TQuery>(item, query?): RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, { collection: (...) | (...); date_created: (...) | (...); date_end: (...) | (...); date_start: (...) | (...); id: string; item: (...) | (...); max_uses: (...) | (...); name: (...) | (...); password: (...) | (...); role: (...) | (...) | (...); times_used: (...) | (...); user_created: (...) | (...) | (...) }, "directus_shares" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; date_created: ...; date_end: ...; date_start: ...; id: ...; item: ...; max_uses: ...; name: ...; password: ...; role: ...; times_used: ...; user_created: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { collection: (...) | (...); date_created: (...) | (...); date_end: (...) | (...); date_start: (...) | (...); id: string; item: (...) | (...); max_uses: (...) | (...); name: (...) | (...); password: (...) | (...); role: (...) | (...) | (...); times_used: (...) | (...); user_created: (...) | (...) | (...) }, "directus_shares" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; date_created: ...; date_end: ...; date_start: ...; id: ...; item: ...; max_uses: ...; name: ...; password: ...; role: ...; times_used: ...; user_created: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { collection: ...; date_created: ...; date_end: ...; date_start: ...; id: ...; item: ...; max_uses: ...; name: ...; password: ...; role: ...; times_used: ...; user_created: ... }, (...) 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/shares.ts:40

Create a new share.

Type Parameters ​

• Schema

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

Parameters ​

item ​

Partial<DirectusShare<Schema>>

The share 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, { collection: (...) | (...); date_created: (...) | (...); date_end: (...) | (...); date_start: (...) | (...); id: string; item: (...) | (...); max_uses: (...) | (...); name: (...) | (...); password: (...) | (...); role: (...) | (...) | (...); times_used: (...) | (...); user_created: (...) | (...) | (...) }, "directus_shares" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; date_created: ...; date_end: ...; date_start: ...; id: ...; item: ...; max_uses: ...; name: ...; password: ...; role: ...; times_used: ...; user_created: ... }>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, { collection: (...) | (...); date_created: (...) | (...); date_end: (...) | (...); date_start: (...) | (...); id: string; item: (...) | (...); max_uses: (...) | (...); name: (...) | (...); password: (...) | (...); role: (...) | (...) | (...); times_used: (...) | (...); user_created: (...) | (...) | (...) }, "directus_shares" extends keyof (...) ? (...) extends (...) ? (...) : (...) : { collection: ...; date_created: ...; date_end: ...; date_start: ...; id: ...; item: ...; max_uses: ...; name: ...; password: ...; role: ...; times_used: ...; user_created: ... }>>, FieldsWildcard<UnpackList<IfAny<Schema, { collection: ...; date_created: ...; date_end: ...; date_start: ...; id: ...; item: ...; max_uses: ...; name: ...; password: ...; role: ...; times_used: ...; user_created: ... }, (...) 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 share object for the created share.