Class UmbExtensionRegistry<IncomingManifestTypes, ManifestTypes>

constructor

• new UmbExtensionRegistry<IncomingManifestTypes, ManifestTypes>(): UmbExtensionRegistry<IncomingManifestTypes, ManifestTypes>

• Type Parameters

  • IncomingManifestTypes extends ManifestBase
  • ManifestTypes extends ManifestBase = ManifestBase | IncomingManifestTypes

  Returns UmbExtensionRegistry<IncomingManifestTypes, ManifestTypes>

ReadonlyMANIFEST_TYPES

Readonlyextensions

Readonlykinds

byAlias

• byAlias<T>(alias): Observable<undefined | T>

• Get an observable that provides an extension matching the given alias.

  Type Parameters

  • T extends ManifestBase = ManifestBase

  Parameters

  • alias: string

    {string} - The alias of the extension to get.

  Returns Observable<undefined | T>

  • An observable of the extension that matches the alias.

byType

• byType<Key, T>(type): Observable<T[]>

• Get an observable that provides extensions matching the given type.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    {string} - The type of the extensions to get.

  Returns Observable<T[]>

  • An observable of the extensions that matches the type.

byTypeAndAlias

• byTypeAndAlias<Key, T>(type, alias): Observable<undefined | T>

• Get an observable that provides extensions matching the given type and alias.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    {string} - The type of the extensions to get.
  • alias: string

    {string} - The alias of the extensions to get.

  Returns Observable<undefined | T>

  • An observable of the extensions that matches the type and alias.

byTypeAndAliases

• byTypeAndAliases<Key, T>(type, aliases): Observable<T[]>

• Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key
  • aliases: string[]

  Returns Observable<T[]>

byTypeAndFilter

• byTypeAndFilter<Key, T>(type, filter): Observable<T[]>

• Get an observable of extensions by type and a given filter method. This will return the all extensions that matches the type and which filter method returns true. The filter method will be called for each extension manifest of the given type, and the first argument to it is the extension manifest.

  Type Parameters

  • Key extends string
  • T extends ManifestBase = SpecificManifestTypeOrManifestBase<ManifestTypes, Key>

  Parameters

  • type: Key

    {string} - The type of the extension to get
  • filter: ((ext: T) => boolean)

    {(ext: T): void} - The filter method to use to filter the extensions

    • • (ext): boolean

      • Parameters

        • ext: T

        Returns boolean

  Returns Observable<T[]>

  • An observable of the extensions that matches the type and filter method

byTypes

• byTypes<ExtensionTypes>(types): Observable<ExtensionTypes[]>

• Get an observable that provides extensions matching given types.

  Type Parameters

  • ExtensionTypes extends ManifestBase = ManifestBase

  Parameters

  • types: string[]

    {Array} - The types of the extensions to get.

  Returns Observable<ExtensionTypes[]>

  • An observable of the extensions that matches the types.

byTypesAndFilter

• byTypesAndFilter<ExtensionTypes>(types, filter): Observable<ExtensionTypes[]>

• Get an observable of extensions by types and a given filter method. This will return the all extensions that matches the types and which filter method returns true. The filter method will be called for each extension manifest of the given types, and the first argument to it is the extension manifest.

  Type Parameters

  • ExtensionTypes extends ManifestBase = ManifestBase

  Parameters

  • types: string[]

    {Array} - The types of the extensions to get.
  • filter: ((ext: ExtensionTypes) => boolean)

    {(ext: T): void} - The filter method to use to filter the extensions

    • • (ext): boolean

      • Parameters

        • ext: ExtensionTypes

        Returns boolean

  Returns Observable<ExtensionTypes[]>

  • An observable of the extensions that matches the type and filter method

defineKind

• defineKind(kind): void

• Parameters

  • kind: ManifestKind<ManifestTypes>

  Returns void

exclude

• exclude(alias): void

• Parameters

  • alias: string

  Returns void

getAllExtensions

• getAllExtensions(): ManifestTypes[]

• Returns ManifestTypes[]

getByAlias

• getByAlias<T>(alias): undefined | T

• Get an extension that matches the given alias, this will not return an observable, it is a one of retrieval if it exists at the given point in time.

  Type Parameters

  • T extends ManifestBase = ManifestBase

  Parameters

  • alias: string

    {string} - The alias of the extension to get.

  Returns undefined | T

  • The extension manifest that matches the alias.

isRegistered

• isRegistered(alias): boolean

• Parameters

  • alias: string

  Returns boolean

register

• register(manifest): void

• Parameters

  • manifest: ManifestTypes | ManifestKind<ManifestTypes>

  Returns void

registerMany

• registerMany(manifests): void

• Parameters

  • manifests: (ManifestTypes | ManifestKind<ManifestTypes>)[]

  Returns void

unregister

• unregister(alias): void

• Parameters

  • alias: string

  Returns void

unregisterMany

• unregisterMany(aliases): void

• Parameters

  • aliases: string[]

  Returns void