includes a function for installing plugins on top of the library.

Hierarchy

  • default

Constructors

Properties

Methods

Constructors

Properties

libraryName: "matter-ts" = 'matter-ts'

The library name.

used: string[] = []

The plugins that have been installed through Matter.Plugin.install. Read only.

uses: string[] = []

A list of plugin dependencies to be installed. These are normally set and installed through Matter.use. Alternatively you may set Matter.uses manually and install them by calling Plugin.use(Matter).

version: string = ...

The library version.

Methods

  • Chains a function to excute after the original function on the given path relative to Matter. See also docs for Common.chain.

    Parameters

    • path: string

      The path relative to Matter

    • func: Function

      The function to chain after the original

    Returns Function

    The chained function that replaced the original

  • Chains a function to excute before the original function on the given path relative to Matter. See also docs for Common.chain.

    Parameters

    • path: string

      The path relative to Matter

    • func: Function

      The function to chain before the original

    Returns Function

    The chained function that replaced the original

  • Installs the given plugins on the Matter namespace. This is a short-hand for Plugin.use, see it for more information. Call this function once at the start of your code, with all of the plugins you wish to install as arguments. Avoid calling this function multiple times unless you intend to manually control installation order.

    Parameters

    • Rest ...params: (string | IPlugin)[]

      The plugin(s) to install on base (multi-argument).

    Returns void

Generated using TypeDoc