Skip to main content

SceneTagged

Hierarchy

Index

Methods

Properties

Constructors

Methods

staticfromJSON

externalequals

  • equals(another: TinyType): boolean
  • @desc

    Compares two tiny types by value

    @example
    <caption>Comparing simple types</caption> class Id extends TinyTypeOf<string>() {}

    const id = new Id(3cc0852d-fda7-4f61-874e-0cfadbd6182a);

    id.equals(id) === true

    @example

    Comparing complex types recursively

    class FirstName extends TinyTypeOf<string>() {}
    class LastName  extends TinyTypeOf<string>() {}
    class Age       extends TinyTypeOf<number>() {}

    class Person extends TinyType {
      constructor(public readonly firstName: FirstName,
                  public readonly lastName:  LastName,
                  public readonly age:       Age,
      ) {
        super();
      }
    }

    const p1 = new Person(new FirstName('John'), new LastName('Smith'), new Age(42)),
          p2 = new Person(new FirstName('John'), new LastName('Smith'), new Age(42));

    p1.equals(p2) === true

    Parameters

    • externalanother: TinyType

    Returns boolean

externaltoString

  • toString(): string
  • @desc

    Serialises the object to its string representation

    Returns string

externaltoJSON

  • toJSON(): JSONValue
  • @desc

    Serialises the object to a JSON representation.

    @example
    class FirstName extends TinyTypeOf<string>() {}

    const name = new FirstName('Jan');

    name.toJSON() === 'Jan'
    @example
    class FirstName extends TinyTypeOf<string>() {}
    class LastName  extends TinyTypeOf<string>() {}
    class Age       extends TinyTypeOf<number>() {}

    class Person extends TinyType {
      constructor(public readonly firstName: FirstName,
                  public readonly lastName:  LastName,
                  public readonly age:       Age,
      ) {
        super();
      }
    }

    const person = new Person(new FirstName('John'), new LastName('Smith'), new Age(42)),

    person.toJSON() === { firstName: 'John', lastName: 'Smith', age: 42 }

    Returns JSONValue

Properties

publicreadonlytimestamp

timestamp: Timestamp = ...

publicreadonlysceneId

sceneId: CorrelationId

publicreadonlytag

tag: Tag

Constructors

constructor

  • Parameters

    • sceneId: CorrelationId
    • tag: Tag
    • optionaltimestamp: Timestamp

    Returns SceneTagged