externalExpectationOutcome

An outcome of an Expectation, which could be either met or not met.

Hierarchy

• TinyType
  • ExpectationOutcome
    • ExpectationMet
    • ExpectationNotMet

Index

Constructors

• constructor

Properties

• message
• expectation
• expected
• actual

Methods

• equals
• toString
• toJSON

Constructors

externalconstructor

• new ExpectationOutcome(message: string, expectation: ExpectationDetails, expected: unknown, actual: unknown): ExpectationOutcome

• Overrides TinyType.constructor

  Parameters

  • externalmessage: string

  • externalexpectation: ExpectationDetails

  • externalexpected: unknown

  • externalactual: unknown

  Returns ExpectationOutcome

Properties

publicexternalreadonlymessage

message: string

publicexternalreadonlyexpectation

expectation: ExpectationDetails

publicexternalreadonlyexpected

expected: unknown

publicexternalreadonlyactual

actual: unknown

Methods

externalequals

• equals(another: TinyType): boolean

• Inherited from TinyType.equals

  @desc

  Compares two tiny types by value

  @example

  class Id extends TinyTypeOf<string>() {}
  
  const id = new Id(`3cc0852d-fda7-4f61-874e-0cfadbd6182a`);
  
  id.equals(id) === true

  @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 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

• Inherited from TinyType.toString

  @desc

  Serialises the object to its string representation

  ---

  Returns string

externaltoJSON

• toJSON(): JSONValue

• Inherited from TinyType.toJSON

  @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