DefaultContainer
create
ensure
exists
fromString
fuzzyMatch
getAll
getFromId
getId
remove
update
DefaultContainer: Readonly<ContextualIdentity> = ...

  • Creates a container from the specified parameters.Does not allow multiple containers with the same name.

    Parameters

    • name: string

      The container name.

    • color: string = "random"

      The container color, must be one of: "blue", "turquoise", "green", "yellow", "orange", "red", "pink" or "purple". If nothing is supplied, it selects one at random.

    • icon: string = "fingerprint"

      The container icon, must be one of: "fingerprint", "briefcase", "dollar", "cart", "circle", "gift", "vacation", "food", "fruit", "pet", "tree", "chill"

    • orUpdate: boolean = false

      Update an existing case-insensitive match instead of failing.

    Returns Promise<string>

  • Parameters

    • name: string
    • color: string = "random"
    • icon: string = "fingerprint"

    Returns Promise<string>

  • Fetches all containers from Firefox's contextual identities API and checks if one exists with the specified name. Note: This operation is entirely case-insensitive.

    Parameters

    • cname: string

    Returns Promise<boolean>

    boolean Returns true when cname matches an existing container or on query error.

  • Takes string parameters and returns them as a pseudo container object for use in other functions in the library.

    Parameters

    • name: string
    • color: string
    • icon: string
    • id: string = ""

    Returns ContextualIdentity

  • Tries some simple ways to match containers to your input. Fuzzy matching is entirely case-insensitive.

    Parameters

    • partialName: string

      The (partial) name of the container.

    Returns Promise<string>

  • Returns Promise<any[]>

    An array representation of all containers.

  • Gets a container object from a supplied container id string. If no container corresponds to containerId, returns a default empty container.

    Parameters

    • containerId: string

      Expects a cookieStringId e.g. "firefox-container-n"

    Returns Promise<ContextualIdentity>

  • Fetches the cookieStoreId of a given container

    Note: all checks are case insensitive.

    Parameters

    • name: string

      The container name

    Returns Promise<string>

    The lowest cookieStoreId matching the name.

  • Removes specified container. No fuzzy matching is intentional here. If there are multiple containers with the same name (allowed by other container plugins), it chooses the one with the lowest cookieStoreId

    Parameters

    • name: string

      The container name

    Returns Promise<void>

  • Updates the specified container. TODO: pass an object to this when tridactyl gets proper flag parsing NOTE: while browser.contextualIdentities.create does check for valid color/icon combos, browser.contextualIdentities.update does not.

    Parameters

    • containerId: string

      Expects a cookieStringId e.g. "firefox-container-n".

    • updateObj: { color: string; icon: string; name: string }

      the new name, color, and icon of the container

    Returns Promise<ContextualIdentity>