@outbook/stubs

Small stub helpers for tests, event handlers, and functional placeholders.

Install

npm install @outbook/stubs

Usage

import {
  constant,
  noop,
  stubArray,
  stubObject,
  stubString
} from '@outbook/stubs';

const config = stubObject();
const labels = stubArray();
const title = stubString();
const answer = constant(42);

noop();

console.log(config, labels, title, answer());

Subpath exports

import { noop, stubNull, stubUndefined } from '@outbook/stubs/functions';
import { alwaysFalse, alwaysTrue } from '@outbook/stubs/predicates';
import { resolves, rejects } from '@outbook/stubs/async';
import { preventDefault, stopPropagation } from '@outbook/stubs/events';

API

Functions

• noop() and empty(): return undefined.
• identity(value): returns value.
• constant(value): returns a function that always returns value.
• stubString(): returns ''.
• stubArray(): returns [].
• stubObject(): returns {}.
• stubNull(): returns null.
• stubUndefined(): returns undefined.

Predicates

• alwaysTrue() and stubTrue(): return true.
• alwaysFalse() and stubFalse(): return false.

Async

• asyncNoop(): resolves with undefined.
• asyncIdentity(value): resolves with value.
• asyncAlwaysTrue(): resolves with true.
• asyncAlwaysFalse(): resolves with false.
• resolves(value): returns a function that resolves with value.
• rejects(error): returns a function that rejects with error.

Events

• preventDefault(event): calls event.preventDefault().
• stopPropagation(event): calls event.stopPropagation().