@league-of-foundry-developers/foundry-vtt-types 9.249.3 → 9.255.1

package/src/foundry/foundry.js/avMaster.d.ts

@@ -29,24 +29,26 @@ declare class AVMaster {
   protected _connected: boolean;
 
   /**
-   * A flag to track whether the A/V system is currently in the process of reconnecting.
-   * This occurs if the connection is lost or interrupted.
-   * @defaultValue `false`
+   * The cached connection promise.
+   * This is required to prevent re-triggering a connection while one is already in progress.
+   * @defaultValue `null`
    * @internal
    */
-  protected _reconnecting: boolean;
+  protected _connecting: Promise<boolean> | null;
 
   /**
-   * @defaultValue `{}`
+   * A flag to track whether the A/V system is currently in the process of reconnecting.
+   * This occurs if the connection is lost or interrupted.
+   * @defaultValue `false`
    * @internal
    */
-  protected _speakingData: AVMaster.SpeakingData;
+  protected _reconnecting: boolean;
 
   /**
    * @defaultValue `{}`
    * @internal
    */
-  protected _pttHandlers: AVMaster.PTTHandlers;
+  protected _speakingData: { speaking: boolean; volumeHistories: number[] };
 
   /**
    * @defaultValue `0`
@@ -54,7 +56,7 @@ declare class AVMaster {
    */
   protected _pttMuteTimeout: number;
 
-  get mode(): AVSettings.VoiceMode;
+  get mode(): AVSettings.AV_MODES;
 
   /**
    * Connect to the Audio/Video client.
@@ -111,29 +113,27 @@ declare class AVMaster {
    * @param mode - The currently selected voice broadcasting mode
    * @internal
    */
-  protected _initializeUserVoiceDetection(mode: AVSettings.VoiceMode): void;
+  protected _initializeUserVoiceDetection(mode: AVSettings.VOICE_MODES): void;
 
   /**
    * Activate voice detection tracking for a userId on a provided MediaStream.
    * Currently only a MediaStream is supported because MediaStreamTrack processing is not yet supported cross-browser.
-   * @param userId - The Foundry User ID whose voice is being processed
    * @param stream - The MediaStream which corresponds to that User
    * @param ms     - A number of milliseconds which represents the voice activation volume interval
    *                 (default: `CONFIG.WebRTC.detectPeerVolumeInterval`)
    */
-  activateVoiceDetection(userId: string, stream: MediaStream, ms?: number): void;
+  activateVoiceDetection(stream: MediaStream, ms?: number): void;
 
   /**
    * Actions which the orchestration layer should take when a peer user disconnects from the audio/video service.
-   * @param userId - The id of the disconnecting User
    */
-  deactivateVoiceDetection(userId: string): void;
+  deactivateVoiceDetection(): void;
 
   /**
    * Periodic notification of user audio level
    *
-   * This function uses the audio level (in dB) of each stream it's listening to to determine if a user
-   * is speaking or not and notifies the UI of such changes.
+   * This function uses the audio level (in dB) of the audio stream to determine if the user is speaking or not and
+   * notifies the UI of such changes.
    *
    * The User is considered speaking if they are above the decibel threshold in any of the history values.
    * This marks them as speaking as soon as they have a high enough volume, and marks them as not speaking only after
@@ -142,46 +142,31 @@ declare class AVMaster {
    * There can be more optimal ways to do this and which uses whether the user was already considered speaking before
    * or not, in order to eliminate short bursts of audio (coughing for example).
    *
-   * @param userId  - The user ID of the user whose audio levels are being reported
    * @param dbLevel - The audio level in decibels of the user within the last 50ms
    * @internal
    */
-  protected _onAudioLevel(userId: string, dbLevel: number): void;
-
-  /**
-   * Set up interactivity and handling of push-to-talk broadcasting workflow.
-   * @internal
-   */
-  protected _initializePushToTalk(): void;
+  protected _onAudioLevel(dbLevel: number): void;
 
   /**
    * Resets the speaking history of a user
    * If the user was considered speaking, then mark them as not speaking
-   * @param userId - The ID of the user
    * @internal
    */
-  protected _resetSpeakingHistory(userId: string): void;
+  protected _resetSpeakingHistory(): void;
 
   /**
    * Handle activation of a push-to-talk key or button.
-   * @param event - The original keydown event
+   * @param context - The context data of the event
    * @internal
    */
-  _onPTTStart(event: KeyboardEvent | MouseEvent): void;
+  _onPTTStart(context: KeyboardEventContext): void;
 
   /**
    * Handle deactivation of a push-to-talk key or button.
-   * @param event - The original keyup event
+   * @param context - The context data of the event
    * @internal
    */
-  _onPTTEnd(event: KeyboardEvent | MouseEvent): void;
-
-  /**
-   * Handle matching old and new PTT configurations against the mouse or keyboard event.
-   * @param event - The original event
-   * @internal
-   */
-  _isPTTKey(event: KeyboardEvent | MouseEvent): boolean;
+  _onPTTEnd(context: KeyboardEventContext): void;
 
   render(): void;
 
@@ -200,15 +185,3 @@ declare class AVMaster {
 
   debug(message: string): void;
 }
-
-declare namespace AVMaster {
-  type SpeakingData = Partial<Record<string, { speaking: boolean; volumeHistories: number[] }>>;
-  type PTTHandler = (event: KeyboardEvent | MouseEvent) => void;
-  type PTTHandlers =
-    | {}
-    | { mousedown: PTTHandler; mouseup: PTTHandler }
-    | {
-        keydown: PTTHandler;
-        keyup: PTTHandler;
-      };
-}

package/src/foundry/foundry.js/avSettings.d.ts

@@ -12,9 +12,11 @@ interface AVSettingsData {
 declare class AVSettings {
   constructor();
 
-  protected _set<T>(key: string, value: T): void;
+  /** @internal */
+  protected _set: <T>(key: string, value: T) => void;
 
-  protected _change(): void;
+  /** @internal */
+  protected _change: () => void;
 
   client: AVSettings.ClientSettings;
 
@@ -74,15 +76,7 @@ declare class AVSettings {
       /**
        * @defaultValue `'AVSettings.VOICE_MODES.PTT'`
        */
-      mode: AVSettings.VoiceMode;
-
-      /**
-       * @defaultValue
-       * ```
-       * "`"
-       * ```
-       */
-      pttKey: string;
+      mode: AVSettings.VOICE_MODES;
 
       /**
        * @defaultValue
@@ -92,11 +86,6 @@ declare class AVSettings {
        */
       pttName: string;
 
-      /**
-       * @defaultValue `false`
-       */
-      pttMouse: boolean;
-
       /**
        * @defaultValue `100`
        */
@@ -111,41 +100,14 @@ declare class AVSettings {
     /**
      * @defaultValue `{}`
      */
-    users: Partial<Record<string, AVSettings.StoredUserSettings>>;
+    users: Record<string, AVSettings.StoredUserSettings>;
   };
 
   static DEFAULT_WORLD_SETTINGS: {
     /**
      * @defaultValue `AVSettings.AV_MODES.DISABLED`
      */
-    mode: AVSettings.VoiceMode;
-
-    server: {
-      /**
-       * @defaultValue `'FVTT'`
-       */
-      type: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      url: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      room: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      username: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      password: string;
-    };
+    mode: AVSettings.AV_MODES;
 
     turn: {
       /**
@@ -217,6 +179,11 @@ declare class AVSettings {
     blocked: boolean;
   };
 
+  /**
+   * Stores the transient AV activity data received from other users.
+   */
+  activity: Record<string, AVSettingsData>;
+
   initialize(): void;
 
   changed(): void;
@@ -243,6 +210,11 @@ declare class AVSettings {
    * @internal
    */
   protected _onSettingsChanged(): void;
+
+  /**
+   * Handle another connected user changing their AV settings.
+   */
+  handleUserActivity(userId: string, settings: AVSettingsData): void;
 }
 
 declare namespace AVSettings {
@@ -259,5 +231,6 @@ declare namespace AVSettings {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface Overrides {}
   type VoiceModes = PropertyTypeOrFallback<AVSettings.Overrides, 'VoiceModes', DefaultVoiceModes>;
-  type VoiceMode = ValueOf<VoiceModes>;
+  type VOICE_MODES = ValueOf<VoiceModes>;
+  type AV_MODES = ValueOf<typeof AVSettings.AV_MODES>;
 }

package/src/foundry/foundry.js/canvas.d.ts

@@ -124,9 +124,6 @@ declare global {
       /** @defaultValue `[]` */
       values: number[];
 
-      /** @defaultValue `0` */
-      last: number;
-
       /** @defaultValue `0` */
       average: number;
 
@@ -135,9 +132,6 @@ declare global {
 
       /** @defaultValue `document.getElementById("fps")` */
       element: HTMLElement;
-
-      /** @defaultValue `undefined` */
-      fn: TickerCallback<void> | undefined;
     };
 
     /**
@@ -541,8 +535,6 @@ declare global {
   }
 }
 
-type TickerCallback<T> = (this: T, dt: number) => any;
-
 interface PerformanceSettings {
   mode: foundry.CONST.CANVAS_PERFORMANCE_MODES;
   blur: {

package/src/foundry/foundry.js/clientDatabaseBackend.d.ts

@@ -69,6 +69,7 @@ declare global {
      * Handle a SocketResponse from the server when one or multiple documents were created
      * @param response - The provided Socket response
      * @returns An Array of created Document instances
+     * @internal
      */
     protected _handleCreateDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -76,6 +77,7 @@ declare global {
      * Handle a SocketResponse from the server when one or multiple documents were created
      * @param response - The provided Socket response
      * @returns An Array of created Document instances
+     * @internal
      */
     protected _handleCreateEmbeddedDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -125,6 +127,7 @@ declare global {
      * Handle a SocketResponse from the server when one or multiple documents were updated
      * @param response - The provided Socket response
      * @returns An Array of updated Document instances
+     * @internal
      */
     protected _handleUpdateDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -132,6 +135,7 @@ declare global {
      * Handle a SocketResponse from the server when embedded Documents are updated in a parent Document.
      * @param response - The provided Socket response
      * @returns An Array of updated Document instances
+     * @internal
      */
     protected _handleUpdateEmbeddedDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -178,6 +182,7 @@ declare global {
      * Handle a SocketResponse from the server where Documents are deleted.
      * @param response - The provided Socket response
      * @returns An Array of deleted Document instances
+     * @internal
      */
     protected _handleDeleteDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 
@@ -185,6 +190,7 @@ declare global {
      * Handle a SocketResponse from the server when embedded Documents are deleted from a parent Document.
      * @param response - The provided Socket response
      * @returns An Array of deleted Document instances
+     * @internal
      */
     protected _handleDeleteEmbeddedDocuments(response: SocketResponse): foundry.abstract.Document<any, any>[];
 

package/src/foundry/foundry.js/clientDocumentMixin.d.ts

@@ -377,8 +377,8 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    * @returns A data object of cleaned data suitable for compendium import
    */
   toCompendium(
-    pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
-    options?: ClientDocumentMixin.CompendiumExportOptions
+    pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+    options?: ClientDocumentMixin.CompendiumExportOptions | undefined
   ): Omit<T['data']['_source'], '_id' | 'folder' | 'permission'> & {
     permission?: T['data']['_source']['permission'];
   };

package/src/foundry/foundry.js/clientDocuments/activeEffect.d.ts

@@ -31,6 +31,11 @@ declare global {
      */
     protected _sheet: FormApplication | null; // TODO: Actually an ActiveEffectConfig according to foundry but this is a problem with ClientDocumentMixins _sheet, this should actually be inferred from the CONFIG
 
+    /**
+     * Is there some system logic that makes this active effect ineligible for application?
+     */
+    get isSuppressed(): boolean;
+
     /**
      * Summarize the active effect duration
      */
@@ -63,12 +68,6 @@ declare global {
      */
     get sourceName(): string;
 
-    /**
-     * An instance of the ActiveEffectConfig sheet to use for this ActiveEffect instance.
-     * The reference to the sheet is cached so the same sheet instance is reused.
-     */
-    get sheet(): FormApplication; // TODO: Actually an ActiveEffectConfig according to foundry but this is a problem with ClientDocumentMixin's sheet, this should actually be inferred from the CONFIG
-
     /**
      * Apply this ActiveEffect to a provided Actor.
      * @param actor  - The Actor to whom this effect should be applied
@@ -138,6 +137,29 @@ declare global {
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
+
+    /** @override */
+    protected _onCreate(
+      data: foundry.data.ActiveEffectData['_source'],
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
+
+    /** @override */
+    protected _onUpdate(
+      data: DeepPartial<foundry.data.ActiveEffectData['_source']>,
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
+
+    /** @override */
+    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+
+    /**
+     * Display changes to active effects as scrolling Token status text.
+     * @internal
+     */
+    protected _displayScrollingStatus(enabled: boolean): void;
   }
 }
 

package/src/foundry/foundry.js/clientDocuments/actor.d.ts

@@ -61,6 +61,11 @@ declare global {
      */
     get img(): this['data']['img'];
 
+    /**
+     * Provide a thumbnail image path used to represent this document.
+     */
+    get thumbnail(): this['data']['img'];
+
     /**
      * Provide an object which organizes all embedded Item instances by their type
      */
@@ -69,7 +74,7 @@ declare global {
       Array<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseItem>>>
     >;
     /**
-     * Test whether an Actor entity is a synthetic representation of a Token (if true) or a full Entity (if false)
+     * Test whether an Actor document is a synthetic representation of a Token (if true) or a full Document (if false)
      */
     get isToken(): boolean;
 
@@ -83,11 +88,6 @@ declare global {
      */
     get token(): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>> | null;
 
-    /**
-     * A convenience reference to the item type (data.type) of this Actor
-     */
-    get type(): this['data']['type'];
-
     /** @override */
     get uuid(): string;
 
@@ -122,9 +122,6 @@ declare global {
      */
     getRollData(): object;
 
-    /** @override */
-    protected _getSheetClass(): ConstructorOf<FormApplication> | null;
-
     /**
      * Create a new TokenData object which can be used to create a Token representation of the Actor.
      * @param data - Additional data, such as x, y, rotation, etc. for the created token data (default: `{}`)
@@ -149,15 +146,15 @@ declare global {
     modifyTokenAttribute(attribute: string, value: number, isDelta: boolean, isBar: boolean): Promise<this | undefined>;
 
     /** @override */
-    prepareEmbeddedEntities(): void;
+    prepareEmbeddedDocuments(): void;
 
     /**
      * Roll initiative for all Combatants in the currently active Combat encounter which are associated with this Actor.
-     * If viewing a full Actor entity, all Tokens which map to that actor will be targeted for initiative rolls.
+     * If viewing a full Actor document, all Tokens which map to that actor will be targeted for initiative rolls.
      * If viewing a synthetic Token actor, only that particular Token will be targeted for an initiative roll.
      *
      * @param options - Configuration for how initiative for this Actor is rolled.
-     * @returns A promise which resolves to the Combat entity once rolls are complete.
+     * @returns A promise which resolves to the Combat document once rolls are complete.
      */
     rollInitiative(options?: Actor.RollInitiativeOptions): Promise<void>;
 
@@ -206,65 +203,11 @@ declare global {
     ): void;
 
     /**
-     * Refresh the display of active Tokens for this Actor if ActiveEffects were changed
-     */
-    protected _refreshTokens(): void;
-
-    /**
-     * You are referencing Actor#_data which has been deprecated in favor of Actor#data#_source. Support for this reference will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    get _data(): this['data']['_source'];
-
-    /**
-     * You are referencing Actor#getOwnedItem(itemId) which is deprecated in favor of Actor#items#get(itemId). Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    getOwnedItem(itemId: string): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseItem>> | undefined;
-
-    /**
-     * You are referencing Actor#createOwnedItem which is deprecated in favor of Item.create or Actor#createEmbeddedDocuments. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    createOwnedItem(
-      itemData: Parameters<this['createEmbeddedDocuments']>[1][] | Parameters<this['createEmbeddedDocuments']>[1],
-      options: Parameters<this['createEmbeddedDocuments']>[2]
-    ): ReturnType<this['createEmbeddedDocuments']>;
-
-    /**
-     * You are referencing Actor#updateOwnedItem which is deprecated in favor of Item#update or Actor#updateEmbeddedDocuments. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    updateOwnedItem(
-      itemData: Parameters<this['updateEmbeddedDocuments']>[1][] | Parameters<this['updateEmbeddedDocuments']>[1],
-      options: Parameters<this['updateEmbeddedDocuments']>[2]
-    ): ReturnType<this['updateEmbeddedDocuments']>;
-
-    /**
-     * You are referencing Actor#deleteOwnedItem which is deprecated in favor of Item#delete or Actor#deleteEmbeddedDocuments. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    deleteOwnedItem(
-      itemId: Parameters<this['deleteEmbeddedDocuments']>[1][] | Parameters<this['deleteEmbeddedDocuments']>[1],
-      options: Parameters<this['deleteEmbeddedDocuments']>[2]
-    ): ReturnType<this['deleteEmbeddedDocuments']>;
-
-    /**
-     * You are referencing Actor.fromToken which is deprecated in favor of TokenDocument#getActor. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    static fromToken(
-      token: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>>
-    ): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>;
-
-    /**
-     * You are referencing Actor.createTokenActor which is deprecated in favor of TokenDocument#getActor. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
+     * Perform various actions on active tokens if embedded documents were changed.
+     * @param embeddedName - The type of embedded document that was modified.
+     * @internal
      */
-    static createTokenActor(
-      _baseActor: unknown,
-      token: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>>
-    ): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>;
+    protected _onEmbeddedDocumentChange(embeddedName: string): void;
   }
   namespace Actor {
     interface RollInitiativeOptions {

package/src/foundry/foundry.js/clientDocuments/canvasDocuments/tokenDocument.d.ts

@@ -1,6 +1,7 @@
 import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 import * as data from '../../../common/data/data.mjs';
+import type { ActiveEffectDataConstructorData } from '../../../common/data/data.mjs/activeEffectData';
 
 declare global {
   /**
@@ -30,8 +31,8 @@ declare global {
 
     /**
      * A lazily evaluated reference to the Actor this Token modifies.
-     * If actorLink is true, then the entity is the primary Actor document.
-     * Otherwise the Actor entity is a synthetic (ephemeral) document constructed using the Token's actorData.
+     * If actorLink is true, then the document is the primary Actor document.
+     * Otherwise the Actor document is a synthetic (ephemeral) document constructed using the Token's actorData.
      */
     get actor(): InstanceType<ConfiguredDocumentClass<typeof Actor>> | null;
 
@@ -55,6 +56,11 @@ declare global {
      */
     get inCombat(): boolean;
 
+    /**
+     * Is the Token currently hidden from player view?
+     */
+    get hidden(): boolean;
+
     /**
      * @param data    - (default: `{}`, unused)
      * @param options - (default: `{}`, unused)
@@ -67,7 +73,7 @@ declare global {
 
     /**
      * Create a synthetic Actor using a provided Token instance
-     * If the Token data is linked, return the true Actor entity
+     * If the Token data is linked, return the true Actor document
      * If the Token data is not linked, create a synthetic Actor using the Token's actorData override
      */
     getActor(): InstanceType<ConfiguredDocumentClass<typeof Actor>> | null;
@@ -83,6 +89,18 @@ declare global {
       { alternative }?: { alternative?: string }
     ): SingleAttributeBar | ObjectAttributeBar | null;
 
+    /**
+     * A helper function to toggle a status effect which includes an Active Effect template
+     * @param effectData - The Active Effect data, including statusId
+     * @param options    - Options to configure application of the Active Effect
+     *                     (default: `{}`)
+     * @returns Whether the Active Effect is now on or off
+     */
+    toggleActiveEffect(
+      effectData: ActiveEffectDataConstructorData & { id: string; label: string; icon: string },
+      options?: ToggleActiveEffectOptions | undefined
+    ): Promise<boolean>;
+
     /**
      * Redirect updates to a synthetic Token Actor to instead update the tokenData override object.
      * Once an attribute in the Token has been overridden, it must always remain overridden.
@@ -138,10 +156,10 @@ declare global {
 
     /**
      * Redirect deletion of Documents within a synthetic Token Actor to instead update the tokenData override object.
-     * @param embeddedName - The named embedded Document type being modified
-     * @param ids          - The provided differential data with which to update the embedded Documents
-     * @param options      - Provided options which modify the update request
-     * @returns The updated Embedded Document instances
+     * @param embeddedName - The named embedded Document type being deleted
+     * @param ids          - The IDs of Documents to delete
+     * @param options      - Provided options which modify the deletion request
+     * @returns The deleted Embedded Document instances
      */
     deleteActorEmbeddedDocuments(
       embeddedName: 'Item',
@@ -163,6 +181,7 @@ declare global {
 
     /**
      * When the Actor data overrides change for an un-linked Token Actor, simulate the pre-update process.
+     * @internal
      */
     protected _preUpdateTokenActor(
       data: Parameters<foundry.documents.BaseActor['_preUpdate']>[0],
@@ -180,11 +199,16 @@ declare global {
     /**
      * When the base Actor for a TokenDocument changes, we may need to update its Actor instance
      * @param update - (default: `{}`)
+     * @internal
      */
-    protected _onUpdateBaseActor(update?: Parameters<foundry.documents.BaseActor['_onUpdate']>[0]): void;
+    protected _onUpdateBaseActor(
+      update?: Parameters<foundry.documents.BaseActor['_onUpdate']>[0],
+      options?: Parameters<foundry.data.ActorData['update']>[1]
+    ): void;
 
     /**
      * When the Actor data overrides change for an un-linked Token Actor, simulate the post-update process.
+     * @internal
      */
     protected _onUpdateTokenActor(
       data: Parameters<foundry.documents.BaseActor['_onUpdate']>[0],
@@ -228,4 +252,13 @@ interface TrackedAttributes {
   value: string[][];
 }
 
-export {};
+interface ToggleActiveEffectOptions {
+  /**
+   * Should the Active Effect icon be displayed as an overlay on the token?
+   * @defaultValue `false`
+   */
+  overlay?: boolean | undefined;
+
+  /** Force a certain active state for the effect. */
+  active?: boolean | undefined;
+}

package/src/foundry/foundry.js/clientDocuments/cards.d.ts

@@ -72,7 +72,8 @@ declare global {
      * Pass an array of specific Card documents from this document to some other Cards stack.
      * @param to      - Some other Cards document that is the destination for the pass operation
      * @param ids     - The embedded Card ids which should be passed
-     * @param options - (default: `{}`)
+     * @param options - Additional options which modify the pass operation
+     *                  (default: `{}`)
      * @returns An array of the Card embedded documents created within the destination stack
      */
     pass(