Class Case

Hierarchy

Case

Index

Constructors

Methods

check checkFile assume add_array_element add_hit_count add_metric start_timer stop_timer blobs json serialize

Constructors

constructor

new Case(meta: {
    name: string;
    team?: string;
    suite?: string;
    version?: string;
}): Case
Parameters
- meta: {
      name: string;
      team?: string;
      suite?: string;
      version?: string;
  }
  - name: string
  - Optional team?: string
  - Optional suite?: string
  - Optional version?: string
Returns Case

Methods

check

check(key: string, value: ToucaType, options?: CheckOptions): void
Captures the value of a given variable as a data point for the declared test case and associates it with the specified key.
Parameters
- key: string
  
  name to be associated with the captured data point
- value: ToucaType
  
  value to be captured as a test result
- Optional options: CheckOptions
  
  comparison rule for this test result
Returns void

checkFile

checkFile(key: string, path: string): void
Captures an external file as a data point for the declared test case and associates it with the specified key.
Parameters
- key: string
  
  name to be associated with the captured file
- path: string
  
  path to the external file to be captured
Returns void

assume

assume(key: string, value: ToucaType): void
Logs a given value as an assertion for the declared test case and associates it with the specified key.
Parameters
- key: string
  
  name to be associated with the logged test result
- value: ToucaType
  
  value to be logged as a test result
Returns void

add_array_element

add_array_element(key: string, value: ToucaType): void
Adds a given value to a list of results for the declared test case which is associated with the specified key.
Parameters
- key: string
  
  name to be associated with the logged test result
- value: ToucaType
  
  element to be appended to the array
Returns void

add_hit_count

add_hit_count(key: string): void
Increments value of key every time it is executed. creates the key with initial value of one if it does not exist.
Parameters
- key: string
  
  name to be associated with the logged test result
Returns void

add_metric

add_metric(key: string, milliseconds: number): void
Adds an already obtained measurements to the list of captured performance benchmarks.

Useful for logging a metric that is measured without using this SDK.
Parameters
- key: string
  
  name to be associated with this performance benchmark
- milliseconds: number
  
  duration of this measurement in milliseconds
Returns void

start_timer

start_timer(key: string): void
Starts timing an event with the specified name.

Measurement of the event is only complete when function stop_timer is later called for the specified name.
Parameters
- key: string
  
  name to be associated with the performance metric
Returns void

stop_timer

stop_timer(key: string): void
Stops timing an event with the specified name.

Expects function startTimer to have been called previously with the specified name.
Parameters
- key: string
  
  name to be associated with the performance metric
Returns void

blobs

blobs(): [string, BlobType][]
Returns [string, BlobType][]

json

json(): CaseJson
Returns CaseJson

serialize

serialize(): Uint8Array
Returns Uint8Array