Class UmbContextToken<BaseType, ResultType>

constructor

• new UmbContextToken<
      BaseType extends UmbContextMinimal = UmbContextMinimal,
      ResultType extends UmbContextMinimal = BaseType,
  >(
      contextAlias: string,
      apiAlias?: string,
      discriminator?: UmbContextDiscriminator<BaseType, ResultType>,
  ): UmbContextToken<BaseType, ResultType>

  Type Parameters

  • BaseType extends UmbContextMinimal = UmbContextMinimal
  • ResultType extends UmbContextMinimal = BaseType

  Parameters

  • contextAlias: string

    Unique identifier for the context
  • apiAlias: string = 'default'

    Unique identifier for the api
  • Optionaldiscriminator: UmbContextDiscriminator<BaseType, ResultType>

    A discriminator that will be used to discriminate the API — testing if the API lives up to a certain requirement. If the API does not meet the requirement then the consumer will not receive this API.

  Returns UmbContextToken<BaseType, ResultType>

ReadonlycontextAlias

ReadonlyTYPE

`typeof MyToken.TYPE`
Copy

getDiscriminator

• getDiscriminator(): undefined | UmbContextDiscriminator<BaseType, ResultType>

  Get the discriminator method for the token

  Returns undefined | UmbContextDiscriminator<BaseType, ResultType>

  the discriminator method

toString

• toString(): string

  This method must always return the unique alias of the token since that will be used to look up the token in the injector.

  Returns string

  the unique alias of the token