type
TypedReadOptions
TypedReadOptions controls population/projection without changing the generated definition's single-locale or all-locales output shape.
Properties
| Property | Type | Description |
|---|---|---|
Draft | *bool | Draft explicitly includes draft documents when true or restricts reads to published documents when false. Nil preserves the Local API default. |
Select | []query.Path | Select restricts returned document fields. |
Populate | []query.Population | Populate expands configured relationship paths. |
OutputFields | []query.Path | OutputFields limits computed and inverse-join resolution without projecting away stored fields. Nil resolves all output fields; a non-nil empty slice resolves none. |
Actor | *store.Document | Actor is the authenticated document used by access rules. |
ActorCollection | schema.CollectionSlug | ActorCollection identifies the exact auth collection that owns Actor. |
Locale | schema.LocaleCode | Locale selects one configured content locale. Empty uses the application default. |
FallbackLocales | []schema.LocaleCode | FallbackLocales replaces the locale's configured fallback chain when non-nil. |
DisableFallback | bool | DisableFallback requires an exact value in Locale. |
Full signature
type TypedReadOptions struct {
// Draft explicitly includes draft documents when true or restricts reads to
// published documents when false. Nil preserves the Local API default.
Draft *bool
// Select restricts returned document fields.
Select []query.Path
// Populate expands configured relationship paths.
Populate []query.Population
// OutputFields limits computed and inverse-join resolution without
// projecting away stored fields. Nil resolves all output fields; a non-nil
// empty slice resolves none.
OutputFields []query.Path
// Actor is the authenticated document used by access rules.
Actor *store.Document
// ActorCollection identifies the exact auth collection that owns Actor.
ActorCollection schema.CollectionSlug
// Locale selects one configured content locale. Empty uses the application default.
Locale schema.LocaleCode
// FallbackLocales replaces the locale's configured fallback chain when non-nil.
FallbackLocales []schema.LocaleCode
// DisableFallback requires an exact value in Locale.
DisableFallback bool
}