method

RiduClient.create

Create one collection document with capability-checked draft intent.

Arguments

ArgumentTypeDescription
collectionSlugThe collection value.
dataDraftCreateFor<Config, Slug>The data value.
options(MutationLocaleOptions<LocaleFor<Config>> & { draft?: boolean; } & { draft?: true; }) | undefinedThe options value.

Returns

The declared result.

Promise<OutputFor<Config, Slug>>

Full signature (2 overloads)

RiduClient.create<Slug extends DraftCollectionSlug<Config>>( collection: Slug, data: DraftCreateFor<Config, Slug>, options?: CreateOptions<LocaleFor<Config>, true, true> & { draft?: true; }, ): Promise<OutputFor<Config, Slug>> RiduClient.create<Slug extends CollectionSlug<Config>>( collection: Slug, data: CreateFor<Config, Slug>, options?: CreateOptions< LocaleFor<Config>, CollectionVersionsFor<Config, Slug>, CollectionDraftsFor<Config, Slug>, >, ): Promise<OutputFor<Config, Slug>>

Source packages/sdk/src/types.ts:1111

Related types

  • DraftCollectionSlug

    Collection slugs with the generated drafts capability.

  • DraftCreateFor

    Generated input for creating an incomplete draft-capable document.

  • CreateOptions

    Create options, including explicit draft or publish intent for versioned collections.

  • OutputFor

    Resolve a collection document output type.

  • CollectionSlug

    The generated union of collection slugs.

  • CreateFor

    Resolve a collection create input type.

  • MutationLocaleOptions

    Locale and transport options shared by mutations without an optimistic-concurrency contract.