method

RiduClient.global

Read one global with a locale-, projection-, and population-dependent result.

Arguments

Argument	Type	Description
`slug`	`Slug`	The slug value.
`options`	`Options \| undefined`	The options value.

Returns

The declared result.

Promise<LocaleResult<ApplySelect<ApplyPopulate<GlobalOutputFor<Config, Slug>, OptionProperty<Options, "populate">, never>, OptionProperty<Options, "select">>, ApplySelect<ApplyPopulate<GlobalAllLocalesOutputFor<Config, Slug>, OptionProperty<Options, "populate">, LocaleFor<Config>>, OptionProperty<Options, "select">>, Options>>

Full signature

RiduClient.global<
	Slug extends GlobalSlug<Config>,
	const Options extends FindOptions<
			GlobalSelectFor<Config, Slug>,
			GlobalPopulateFor<Config, Slug>,
			LocaleFor<Config>,
			GlobalDraftsFor<Config, Slug>,
		>
			| undefined = undefined,
>(slug: Slug, options?: Options): Promise<GlobalQueryResult<Config, Slug, Options>>

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

Related types

GlobalSlug
The generated union of global slugs.
FindOptions
Projection, population, depth, and locale options for one document or global.
GlobalSelectFor
Resolve a global projection type.
GlobalPopulateFor
Resolve a global population type.
GlobalOutputFor
Resolve a global output type.
GlobalAllLocalesOutputFor
Resolve locale-keyed global output when generated, otherwise ordinary output.