Class CompendiumPacks

A mapping of CompendiumCollection instances, one per Compendium pack

Hierarchy (View Summary)

Accessors

contents folders name

Methods

_getVisibleTreeContents [iterator] filter find forEach get getName map reduce some toJSON _sortAlphabetical

Accessors

contents

  • get contents(): V[]

    Return an Array of all the entry values in the Collection

    Returns V[]

folders

name

  • get name(): string

    The Collection class name

    Returns string

Methods

_getVisibleTreeContents

[iterator]

filter

find

  • find(
        condition: (
            value: CompendiumCollection,
            index: number,
            collection: Collection<string, CompendiumCollection<any>>,
        ) => unknown,
    ): undefined | CompendiumCollection<any>

    Find an entry in the Map using a functional condition.

    Parameters

    Returns undefined | CompendiumCollection<any>

    The value, if found, otherwise undefined

    See

    Example: Create a new Collection and reference its contents

    let c = new Collection([["a", "A"], ["b", "B"], ["c", "C"]]);
    c.get("a") === c.find(entry => entry === "A"); // true

forEach

  • forEach(fn: (value: CompendiumCollection) => void): void

    Apply a function to each element of the collection

    Parameters

    Returns void

    See

    Array#forEach

    Example: Apply a function to each value in the collection

    let c = new Collection([["a", {active: false}], ["b", {active: false}], ["c", {active: false}]]);
    c.forEach(e => e.active = true);

get

  • get(
        key: string,
        options?: { strict?: boolean },
    ): undefined | CompendiumCollection<any>

    Get an element from the Collection by its key.

    Parameters

    • key: string

      The key of the entry to retrieve

    • Optionaloptions: { strict?: boolean } = {}

      Additional options that affect how entries are retrieved

      • Optionalstrict?: boolean

        Throw an Error if the requested key does not exist. Default false.

    Returns undefined | CompendiumCollection<any>

    The retrieved entry value, if the key exists, otherwise undefined

    Example: Get an element from the Collection by key

    let c = new Collection([["a", "Alfred"], ["b", "Bob"], ["c", "Cynthia"]]);
    c.get("a"); // "Alfred"
    c.get("d"); // undefined
    c.get("d", {strict: true}); // throws Error

getName

  • getName(
        name: string,
        options?: { strict?: boolean },
    ): undefined | CompendiumCollection<any>

    Get an entry from the Collection by name. Use of this method assumes that the objects stored in the collection have a "name" attribute.

    Parameters

    • name: string

      The name of the entry to retrieve

    • Optionaloptions: { strict?: boolean } = {}

      Additional options that affect how entries are retrieved

      • Optionalstrict?: boolean

        Throw an Error if the requested name does not exist. Default false.

    Returns undefined | CompendiumCollection<any>

    The retrieved entry value, if one was found, otherwise undefined

    Example: Get an element from the Collection by name (if applicable)

    let c = new Collection([["a", "Alfred"], ["b", "Bob"], ["c", "Cynthia"]]);
    c.getName("Alfred"); // "Alfred"
    c.getName("D"); // undefined
    c.getName("D", {strict: true}); // throws Error

map

  • map(
        transformer: (
            arg0: CompendiumCollection,
            arg1: number,
            arg2: Collection,
        ) => any,
    ): any[]

    Transform each element of the Collection into a new form, returning an Array of transformed values

    Parameters

    • transformer: (arg0: CompendiumCollection, arg1: number, arg2: Collection) => any

      A transformation function applied to each entry value. Positional arguments are the value, the index of iteration, and the collection being mapped.

    Returns any[]

    An Array of transformed values

reduce

  • reduce(
        reducer: (
            arg0: any,
            arg1: CompendiumCollection,
            arg2: number,
            arg3: Collection,
        ) => any,
        initial: any,
    ): any

    Reduce the Collection by applying an evaluator function and accumulating entries

    Parameters

    • reducer: (arg0: any, arg1: CompendiumCollection, arg2: number, arg3: Collection) => any

      A reducer function applied to each entry value. Positional arguments are the accumulator, the value, the index of iteration, and the collection being reduced.

    • initial: any

      An initial value which accumulates with each iteration

    Returns any

    The accumulated result

    See

    Example: Reduce a collection to an array of transformed values

    let c = new Collection([["a", "A"], ["b", "B"], ["c", "C"]]);
    let letters = c.reduce((s, l) => {
      return s + l;
    }, ""); // "ABC"

some

  • some(
        condition: (
            arg0: CompendiumCollection,
            arg1: number,
            arg2: Collection,
        ) => boolean,
    ): boolean

    Test whether a condition is met by some entry in the Collection.

    Parameters

    • condition: (arg0: CompendiumCollection, arg1: number, arg2: Collection) => boolean

      The functional condition to test. Positional arguments are the value, the index of iteration, and the collection being tested.

    Returns boolean

    Was the test condition passed by at least one entry?

    See

toJSON

  • toJSON(): object[]

    Convert the Collection to a primitive array of its contents.

    Returns object[]

    An array of contained values

Static_sortAlphabetical

  • _sortAlphabetical(a: any, b: any): any

    Parameters

    • a: any
    • b: any

    Returns any

Settings

Member Visibility

On This Page

Accessors
Methods