diff --git a/src/types.ts b/src/types.ts index 89309fac..4dd44f36 100644 --- a/src/types.ts +++ b/src/types.ts @@ -932,7 +932,12 @@ export interface ListenOptions { includePreviousRevision?: boolean /** - * @internal + * Whether to include events for drafts and versions. As of API Version >= v2025-02-19, only events + * for published documents will be included by default. + * If you need events from drafts and versions, set this to `true`. + * Note: Keep in mind that additional document variants may be introduced in the future, so it's + * recommended to respond to events in a way that's tolerant of potential future variants, e.g. by + * explicitly checking whether the event is for a draft or a version. * @defaultValue `false` */ includeAllVersions?: boolean