Class Discriminator

Static class methods for evaluating if objects implement various interfaces for type safety.

Since

2.0.0

Index

Constructors

Methods

isAspectRatioConfig isPalette isPaletteColor

Constructors

constructor

new Discriminator(): Discriminator
Returns Discriminator
Throws
- Discriminator is a static class and cannot be instantiated.
Since
2.0.0
- Defined in discriminator/discriminator.ts:43

Methods

`Static`isAspectRatioConfig

isAspectRatioConfig(object: unknown): object is AspectRatioConfig
Does the given object implement the AspectRatioConfig interface?
Parameters
- object: unknown
  {unknown} - The object to check
Returns object is AspectRatioConfig
true if the given object implements the AspectRatioConfig interface, false if it does not.

Since
2.0.0
- Defined in discriminator/discriminator.ts:56

`Static`isPalette

isPalette(object: unknown): object is Palette
Does the given object implement the Palette interface?
Parameters
- object: unknown
  {unknown} - The object to check
Returns object is Palette
true if the given object implements the Palette interface, false if it does not.

Since
2.0.0
- Defined in discriminator/discriminator.ts:69

`Static`isPaletteColor

isPaletteColor(object: unknown): object is PaletteColor
Does the given object implement the PaletteColor interface?
Parameters
- object: unknown
  {unknown} - The object to check
Returns object is PaletteColor
true if the given object implements the PaletteColor interface, false if it does not.

Since
2.0.0
- Defined in discriminator/discriminator.ts:82