Variable preferencesConst

Type declaration

• forColumn:function

  • forColumn<P, Data>(column: Column<Data>, klass: Class<P>): {
        delete(key: string): undefined | void;
        get(key: string): unknown;
        set(key: string, value: unknown): void;
    }

  • returns an object for getting and setting preferences data based on the column (scoped to key)

    Only the provided plugin will have access to these preferences (though, if other plugins can guess how the underlying plugin access works, they can access this data, too. No security guaranteed)

    Type Parameters

    • P extends BasePlugin<any, P>

    • Data = unknown

    Parameters

    • column: Column<Data>

    • klass: Class<P>

    Returns {
        delete(key: string): undefined | void;
        get(key: string): unknown;
        set(key: string, value: unknown): void;
    }

    • delete:function

      • delete(key: string): undefined | void

      • delete an entry on the underlying Map used for this column-plugin pair

        Parameters

        • key: string

        Returns undefined | void

    • get:function

      • get(key: string): unknown

      • get an entry on the underlying Map used for this column-plugin pair

        Parameters

        • key: string

        Returns unknown

    • set:function

      • set(key: string, value: unknown): void

      • set an entry on the underlying Map used for this column-plugin pair

        Parameters

        • key: string

        • value: unknown

        Returns void

• forTable:function

  • forTable<P, Data>(table: Table<Data>, klass: Class<P>): {
        delete(key: string): undefined | void;
        get(key: string): unknown;
        set(key: string, value: unknown): undefined | void;
    }

  • returns an object for getting and setting preferences data based on the table (scoped to the key: "table")

    Only the provided plugin will have access to these preferences (though, if other plugins can guess how the underlying plugin access works, they can access this data, too. No security guaranteed)

    Type Parameters

    • P extends BasePlugin<any, P>

    • Data = unknown

    Parameters

    • table: Table<Data>

    • klass: Class<P>

    Returns {
        delete(key: string): undefined | void;
        get(key: string): unknown;
        set(key: string, value: unknown): undefined | void;
    }

    • delete:function

      • delete(key: string): undefined | void

      • delete an entry on the underlying Map used for this column-plugin pair

        Parameters

        • key: string

        Returns undefined | void

    • get:function

      • get(key: string): unknown

      • get an entry on the underlying Map used for this column-plugin pair

        Parameters

        • key: string

        Returns unknown

    • set:function

      • set(key: string, value: unknown): undefined | void

      • set an entry on the underlying Map used for this column-plugin pair

        Parameters

        • key: string

        • value: unknown

        Returns undefined | void