method

BoundTypedAllLocalesCollection.List

List filters and populates documents through the operation engine, using the same response shape as Find. A failed document decode returns no partial page.

Arguments

ArgumentTypeDescription
ctxcontext.ContextThe ctx value.
optionsTypedListOptionsThe options value.

Returns

The declared result.

(TypedPage[Document], error)

Full signature

func (collection BoundTypedAllLocalesCollection[Document]) List( ctx context.Context, options TypedListOptions, ) (TypedPage[Document], error)

Source core/typed_read.go:105

Related types

  • BoundTypedAllLocalesCollection

    Typed Find and List reads with population, projection and all translations.

  • TypedListOptions

    Filter, paginate, populate and project generated documents without changing the binding’s locale shape.

  • TypedPage

    A typed list result with the ordinary page metadata.