externalExpectationDetails

Used with ExpectationOutcome to describe an Expectation and the arguments it's been executed with.

Hierarchy

• TinyType
  • ExpectationDetails

Index

Properties

• name
• args

Methods

• of
• fromJSON
• toString
• toJSON
• equals

Properties

publicexternalreadonlyname

name: Name

publicexternalreadonlyargs

args: (JSONValue | ExpectationDetails | Unanswered)[]

Methods

staticexternalof

• of(functionName: string, ...functionArguments: (JSONValue | ExpectationDetails | Unanswered)[]): ExpectationDetails

• Parameters

  • externalfunctionName: string

  • externalrest...functionArguments: (JSONValue | ExpectationDetails | Unanswered)[]

  Returns ExpectationDetails

staticexternalfromJSON

• fromJSON(o: JSONObject): ExpectationDetails

• Parameters

  • externalo: JSONObject

  Returns ExpectationDetails

externaltoString

• toString(): string

• Overrides TinyType.toString

  Returns string

externaltoJSON

• toJSON(): { name: string; args: { type: string; value: JSONValue }[] }

• Overrides TinyType.toJSON

  Returns { name: string; args: { type: string; value: JSONValue }[] }

  • externalname: string

  • externalargs: { type: string; value: JSONValue }[]

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