luxe API (2025.1.2)

---

luxe: test module

• BaseMatchers
• ConsoleReporter
• Expectation
• FiberMatchers
• Matchers
• NumMatchers
• RangeMatchers
• Reporter
• Runnable
• Skippable
• Stub
• StubMatchers
• Suite

---

BaseMatchers

import "luxe: test" for BaseMatchers

no docs found

• new(value: Any)
• value
• not
• toBe(klass: Any)
• toBeFalse
• toBeTrue
• toBeNull
• toEqual(other: Any)
• toEqualDeeply(other: Any)

---

BaseMatchers.new(value: Any) returns BaseMatchers

no docs found

BaseMatchers.value returns unknown

no docs found

BaseMatchers.not returns unknown

no docs found

BaseMatchers.toBe(klass: Any) returns unknown

no docs found

BaseMatchers.toBeFalse returns unknown

no docs found

BaseMatchers.toBeTrue returns unknown

no docs found

BaseMatchers.toBeNull returns unknown

no docs found

BaseMatchers.toEqual(other: Any) returns unknown

no docs found

BaseMatchers.toEqualDeeply(other: Any) returns unknown

no docs found

ConsoleReporter

import "luxe: test" for ConsoleReporter

no docs found

• new()
• print_colors=(v : Any)
• epilogue()
• runnableSkipped(skippable: Any)
• suiteStart(title: Any)
• suiteEnd(title: Any)
• testStart(runnable: Any)
• testEnd(runnable: Any)
• testPassed(runnable: Any)
• testFailed(runnable: Any)
• testError(runnable: Any)

---

ConsoleReporter.new() returns ConsoleReporter

no docs found

ConsoleReporter.print_colors=(v : Any) returns unknown

no docs found

ConsoleReporter.epilogue() returns unknown

no docs found

ConsoleReporter.runnableSkipped(skippable: Any) returns unknown

no docs found

ConsoleReporter.suiteStart(title: Any) returns unknown

no docs found

ConsoleReporter.suiteEnd(title: Any) returns unknown

no docs found

ConsoleReporter.testStart(runnable: Any) returns unknown

no docs found

ConsoleReporter.testEnd(runnable: Any) returns unknown

no docs found

ConsoleReporter.testPassed(runnable: Any) returns unknown

no docs found

ConsoleReporter.testFailed(runnable: Any) returns unknown

no docs found

ConsoleReporter.testError(runnable: Any) returns unknown

no docs found

Expectation

import "luxe: test" for Expectation

no docs found

• new(passed: Any, message: Any)
• passed
• message

---

Expectation.new(passed: Any, message: Any) returns Expectation

no docs found

Expectation.passed returns unknown

no docs found

Expectation.message returns unknown

no docs found

FiberMatchers

import "luxe: test" for FiberMatchers

no docs found

• new(value: Any)
• toBeARuntimeError
• toBeARuntimeError(errorMessage: Any)
• toBeDone

---

FiberMatchers.new(value: Any) returns FiberMatchers

no docs found

FiberMatchers.toBeARuntimeError returns unknown

no docs found

FiberMatchers.toBeARuntimeError(errorMessage: Any) returns unknown

no docs found

FiberMatchers.toBeDone returns unknown

no docs found

Matchers

import "luxe: test" for Matchers

no docs found

• new(value: Any)

---

Matchers.new(value: Any) returns Matchers

no docs found

NumMatchers

import "luxe: test" for NumMatchers

no docs found

• new(value: Any)
• toBeGreaterThan(other: Any)
• toBeLessThan(other: Any)
• toBeBetween(min: Any, max: Any)

---

NumMatchers.new(value: Any) returns NumMatchers

no docs found

NumMatchers.toBeGreaterThan(other: Any) returns unknown

no docs found

NumMatchers.toBeLessThan(other: Any) returns unknown

no docs found

NumMatchers.toBeBetween(min: Any, max: Any) returns unknown

no docs found

RangeMatchers

import "luxe: test" for RangeMatchers

no docs found

• new(value: Any)
• toContain(other: Any)
• toBeContainedBy(other: Any)

---

RangeMatchers.new(value: Any) returns RangeMatchers

no docs found

RangeMatchers.toContain(other: Any) returns unknown

no docs found

RangeMatchers.toBeContainedBy(other: Any) returns unknown

no docs found

Reporter

import "luxe: test" for Reporter

no docs found

• epilogue()
• runnableSkipped(skippable: Any)
• suiteStart(title: Any)
• suiteEnd(title: Any)
• testStart(runnable: Any)
• testPassed(runnable: Any)
• testFailed(runnable: Any)
• testError(runnable: Any)
• testEnd(runnable: Any)

---

Reporter.epilogue() returns unknown

no docs found

Reporter.runnableSkipped(skippable: Any) returns unknown

no docs found

Reporter.suiteStart(title: Any) returns unknown

no docs found

Reporter.suiteEnd(title: Any) returns unknown

no docs found

Reporter.testStart(runnable: Any) returns unknown

no docs found

Reporter.testPassed(runnable: Any) returns unknown

no docs found

Reporter.testFailed(runnable: Any) returns unknown

no docs found

Reporter.testError(runnable: Any) returns unknown

no docs found

Reporter.testEnd(runnable: Any) returns unknown

no docs found

Runnable

import "luxe: test" for Runnable

no docs found

• new(title: Any, beforeEaches: Any, afterEaches: Any, fn: Any)
• duration
• error
• expectations
• hasRun
• run()
• title

---

Runnable.new(title: Any, beforeEaches: Any, afterEaches: Any, fn: Any) returns Runnable

no docs found

Runnable.duration returns unknown

no docs found

Runnable.error returns unknown

no docs found

Runnable.expectations returns unknown

no docs found

Runnable.hasRun returns unknown

no docs found

Runnable.run() returns unknown

no docs found

Runnable.title returns unknown

no docs found

Skippable

import "luxe: test" for Skippable

no docs found

• new(title: Any)
• run
• title

---

Skippable.new(title: Any) returns Skippable

no docs found

Skippable.run returns unknown

no docs found

Skippable.title returns unknown

no docs found

Stub

import "luxe: test" for Stub

no docs found

• new(name: Any)
• new(name: Any, fakeFn: Any)
• andCallFake(name: Any, fakeFn: Any)
• andReturnValue(name: Any, returnValue: Any)
• called
• calls
• firstCall
• mostRecentCall
• name
• reset
• call
• call()
• call(a: Any)
• call(a: Any, b: Any)
• call(a: Any, b: Any, c: Any)
• call(a: Any, b: Any, c: Any, d: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any, n: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any, n: Any, o: Any)
• call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any, n: Any, o: Any, p: Any)

---

Stub.new(name: Any) returns Stub

no docs found

Stub.new(name: Any, fakeFn: Any) returns Stub

no docs found

Stub.andCallFake(name: Any, fakeFn: Any) returns unknown

no docs found

Stub.andReturnValue(name: Any, returnValue: Any) returns unknown

no docs found

Stub.called returns unknown

no docs found

Stub.calls returns unknown

no docs found

Stub.firstCall returns unknown

no docs found

Stub.mostRecentCall returns unknown

no docs found

Stub.name returns unknown

no docs found

Stub.reset returns unknown

no docs found

Stub.call returns unknown

no docs found

Stub.call() returns unknown

no docs found

Stub.call(a: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any, n: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any, n: Any, o: Any) returns unknown

no docs found

Stub.call(a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, i: Any, j: Any, k: Any, l: Any, m: Any, n: Any, o: Any, p: Any) returns unknown

no docs found

StubMatchers

import "luxe: test" for StubMatchers

no docs found

• new(value: Any)
• toHaveBeenCalled
• toHaveBeenCalled(times: Any)
• toHaveBeenCalledWith(args: Any)

---

StubMatchers.new(value: Any) returns StubMatchers

no docs found

StubMatchers.toHaveBeenCalled returns unknown

no docs found

StubMatchers.toHaveBeenCalled(times: Any) returns unknown

no docs found

StubMatchers.toHaveBeenCalledWith(args: Any) returns unknown

no docs found

Suite

import "luxe: test" for Suite

no docs found

• new(name: Any, block: Any)
• new(name: Any, beforeEaches: Any, afterEaches: Any, block: Any)
• afterEach
• afterEach(block: Any)
• beforeEach
• beforeEach(block: Any)
• run(reporter: Any)
• should(name: Any)
• should(name: Any, block: Any)
• skip(block: Any)
• suite(name: Any)
• suite(name: Any, block: Any)
• title

---

Suite.new(name: Any, block: Any) returns Suite

no docs found

Suite.new(name: Any, beforeEaches: Any, afterEaches: Any, block: Any) returns Suite

no docs found

Suite.afterEach returns unknown

no docs found

Suite.afterEach(block: Any) returns unknown

no docs found

Suite.beforeEach returns unknown

no docs found

Suite.beforeEach(block: Any) returns unknown

no docs found

Suite.run(reporter: Any) returns unknown

no docs found

Suite.should(name: Any) returns unknown

no docs found

Suite.should(name: Any, block: Any) returns unknown

no docs found

Suite.skip(block: Any) returns unknown

no docs found

Suite.suite(name: Any) returns unknown

no docs found

Suite.suite(name: Any, block: Any) returns unknown

no docs found

Suite.title returns unknown

no docs found