Skip to content
OFFICIAL SS DOCUMENTATION

SS.Testing 1.2.0

Versioned public package API.
API 1.1.0
MIT
source

Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0

No package dependencies declared.

Public API

Public signature
export function assertArrayEqual<T>(T[] actual, T[] expected, string message)

Parameters: actual: T[], expected: T[], message: string


Public signature
export function assertArrayNear(double[] actual, double[] expected, double absoluteTolerance, double relativeTolerance, string message)

Parameters: actual: double[], expected: double[], absoluteTolerance: double, relativeTolerance: double, message: string


Public signature
export function assertEqual<T>(T actual, T expected, string message)

Parameters: actual: T, expected: T, message: string


Public signature
export function assertFalse(bool condition, string message)

Parameters: condition: bool, message: string


Public signature
export function assertMatrixNear(double[] actual, int actualRows, int actualColumns, double[] expected, int expectedRows, int expectedColumns, double absoluteTolerance, double relativeTolerance, string message)

Parameters: actual: double[], actualRows: int, actualColumns: int, expected: double[], expectedRows: int, expectedColumns: int, absoluteTolerance: double, relativeTolerance: double, message: string


Public signature
export function assertNear(double actual, double expected, double absoluteTolerance, double relativeTolerance, string message)

Parameters: actual: double, expected: double, absoluteTolerance: double, relativeTolerance: double, message: string


Public signature
export function assertNotEqual<T>(T actual, T unexpected, string message)

Parameters: actual: T, unexpected: T, message: string


Public signature
export function assertProperty(PropertyPredicate predicate, PropertyOptions options, string name) -> int

Parameters: predicate: PropertyPredicate, options: PropertyOptions, name: string


Public signature
export function assertThrowsDiagnostic(DiagnosticAction action, string expectedCode, string source) -> bool

Parameters: action: DiagnosticAction, expectedCode: string, source: string


Public signature
export function assertTrue(bool condition, string message)

Parameters: condition: bool, message: string


Public signature
export record Case<T>(public string name, public T value)

Parameters: name: string, value: T


Public signature
export interface DiagnosticAction

Testing.fail

function
Public signature
export function fail(string message)

Parameters: message: string


Public signature
export function fixture<T>(T value) -> Fixture<T>

Parameters: value: T


Public signature
export record Fixture<T>(public T value)

Parameters: value: T


Public signature
export function generatedCase(PropertyOptions options, int index) -> PropertyCase

Parameters: options: PropertyOptions, index: int


Public signature
export function parameterizedTestCase<T>(string name, T value, int ordinal, string group) -> Case<T>

Parameters: name: string, value: T, ordinal: int, group: string


Public signature
export record PropertyCase(public int index, public double value, public string replay)

Parameters: index: int, value: double, replay: string


Public signature
export function propertyOptions(int seed, int cases, int maximumShrinkSteps, bool heavy) -> PropertyOptions

Parameters: seed: int, cases: int, maximumShrinkSteps: int, heavy: bool


Public signature
export record PropertyOptions(public int seed, public int cases, public int maximumShrinkSteps, public bool heavy)

Parameters: seed: int, cases: int, maximumShrinkSteps: int, heavy: bool


Public signature
export interface PropertyPredicate

Public signature
export record ShrinkCase(public int step, public double value, public bool complete)

Parameters: step: int, value: double, complete: bool


Public signature
export function shrinkTowardZero(PropertyOptions options, double failingValue, int step) -> ShrinkCase

Parameters: options: PropertyOptions, failingValue: double, step: int


Public signature
export function testCase<T>(string name, T value) -> Case<T>

Parameters: name: string, value: T


Documentation version

Language 1.0.0, compiler 1.0.0, runtime 1.0.0. This reference is generated from the official SS documentation so package and language details stay consistent with the release.