SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IModuleCollection

    Represents a collection of functions. This is analogous to a file.

    Keyed by the module's id, not ordered: iteration order is unspecified. The unfiltered walk (for…of, getCount(), toArray()) is what getItems() returns with no options — the default language's modules; pass { language: null } to getItems for every language.

    interface IModuleCollection {
        isICollection: true;
        isIModuleCollection: true;
        "[iterator]"(): IterableIterator<IModule>;
        add(
            uid: string,
            module: IModule,
            options?: IModuleCollection.AddOptions,
        ): void;
        addListeners(
            listeners: IModuleCollection.IListeners,
            options?: IListener.Options,
        ): Remove;
        at(index: number): IModule | undefined;
        every(
            predicate: (
                value: IModule,
                index: number,
                items: readonly IModule[],
            ) => boolean,
        ): boolean;
        filter<S extends IModule>(
            predicate: (
                value: IModule,
                index: number,
                items: readonly IModule[],
            ) => value is S,
        ): S[];
        filter(
            predicate: (
                value: IModule,
                index: number,
                items: readonly IModule[],
            ) => boolean,
        ): IModule[];
        find<S extends IModule>(
            predicate: (
                value: IModule,
                index: number,
                items: readonly IModule[],
            ) => value is S,
        ): S | undefined;
        find(
            predicate: (
                value: IModule,
                index: number,
                items: readonly IModule[],
            ) => boolean,
        ): IModule | undefined;
        findIndex(
            predicate: (
                value: IModule,
                index: number,
                items: readonly IModule[],
            ) => boolean,
        ): number;
        forEach(
            fn: (value: IModule, index: number, items: readonly IModule[]) => void,
        ): void;
        getByName(name: string): IModule | null;
        getCount(): number;
        getItems(options?: IModuleCollection.GetItemsOptions): IModule[];
        indexOf(item: IModule): number;
        isClosed(): boolean;
        map<U>(
            fn: (value: IModule, index: number, items: readonly IModule[]) => U,
        ): U[];
        some(
            predicate: (
                value: IModule,
                index: number,
                items: readonly IModule[],
            ) => boolean,
        ): boolean;
        toArray(): IModule[];
        toJSON(): Record<string, IModule.JSON>;
    }

    Hierarchy (View Summary)

    Index
    isICollection isIModuleCollection
    [iterator] add addListeners at every filter find findIndex forEach getByName getCount getItems indexOf isClosed map some toArray toJSON
    isICollection: true

    For runtime type checking.

    isIModuleCollection: true

    For runtime type checking.

    • Iterates the collection's items.

      Returns IterableIterator<IModule>

      The unfiltered walk — for (const sheet of wb.getSheets()). Every other iterable surface in the SDK (ICellRange, ICellRegions, ICellRanges) reads this way, so a collection that did not was a trap: for…of over one is the obvious line to write and it threw at runtime with nothing in the types to warn first.

      getItems remains the call that takes options — filtering, ordering, anything parameterized. This is sugar over the unfiltered case, not a replacement for it.

    • Adds the module to the collection.

      Parameters

      • uid: string

        A unique identifier for the module. This can be either a name, a fully qualified path, or a url (e.g., a file name, a Git url with commit ID).

      • module: IModule

        The module to add. This will generally come from IScript.createModule.

      • Optionaloptions: IModuleCollection.AddOptions

        The options for adding the module.

      Returns void

    • Returns the item at the given index, or undefined if there is none.

      Parameters

      • index: number

        The position in iteration order. A negative index counts back from the end, as Array.prototype.at does.

      Returns IModule | undefined

    • Returns true if the predicate accepts every item, including when there are none.

      Parameters

      • predicate: (value: IModule, index: number, items: readonly IModule[]) => boolean

        Called once per item in iteration order until it returns false.

      Returns boolean

    • Returns the items the predicate accepts, in iteration order.

      Type Parameters

      Parameters

      • predicate: (value: IModule, index: number, items: readonly IModule[]) => value is S

        Called once per item.

      Returns S[]

    • Returns the items the predicate accepts, in iteration order.

      Parameters

      • predicate: (value: IModule, index: number, items: readonly IModule[]) => boolean

        Called once per item.

      Returns IModule[]

    • Returns the first item the predicate accepts, or undefined if it accepts none.

      Type Parameters

      Parameters

      • predicate: (value: IModule, index: number, items: readonly IModule[]) => value is S

        Called once per item in iteration order until it returns true.

      Returns S | undefined

    • Returns the first item the predicate accepts, or undefined if it accepts none.

      Parameters

      • predicate: (value: IModule, index: number, items: readonly IModule[]) => boolean

        Called once per item in iteration order until it returns true.

      Returns IModule | undefined

    • Returns the index of the first item the predicate accepts, or -1 if it accepts none.

      Parameters

      • predicate: (value: IModule, index: number, items: readonly IModule[]) => boolean

        Called once per item in iteration order until it returns true.

      Returns number

    • Calls the function once per item, in iteration order.

      Parameters

      • fn: (value: IModule, index: number, items: readonly IModule[]) => void

        Called once per item.

      Returns void

    • Convenience method for filtering by name. This is functionally equivalent to getItems({ name });

      Parameters

      • name: string

        The name to search for This is case insensitive.

      Returns IModule | null

    • Returns the total items available.

      Returns number

      returns the total number of items available.

    • Returns the index of the item in iteration order, or -1 if it is not in the collection.

      Parameters

      Returns number

    • Returns true once the collection has been closed.

      Returns boolean

      A closed collection is empty and announces nothing further. Collections that are closed by their owner (the workbook's names, functions and modules, when the workbook closes) announce it once with ICollection.Events.onClose; the others are never closed and always return false.

    • Returns the result of calling the function on every item, in iteration order.

      Type Parameters

      • U

      Parameters

      • fn: (value: IModule, index: number, items: readonly IModule[]) => U

        Called once per item.

      Returns U[]

    • Returns true if the predicate accepts at least one item.

      Parameters

      • predicate: (value: IModule, index: number, items: readonly IModule[]) => boolean

        Called once per item in iteration order until it returns true.

      Returns boolean

    • Returns the items as a fresh array, in iteration order.

      Returns IModule[]

      The call to make when an array is really wanted. The array is the caller's: changing it does not change the collection, and it does not follow later changes to the collection.

    • Returns a JSON representation of the module collection.

      Returns Record<string, IModule.JSON>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods