action.spec.ts

import * as T from './type-helpers'; // type-tests global
import { action } from './action';

// @dts-jest:group with symbol
{
  const ACTION = Symbol(1);
  const withSymbol = () => action(ACTION as any);
  // @dts-jest:pass:snap
  withSymbol(); // => { type: ACTION }
}

// @dts-jest:group with type only
{
  const withTypeOnly = () => action('ACTION');
  // @dts-jest:pass:snap
  withTypeOnly(); // => { type: 'ACTION' }
}

// @dts-jest:group with payload
{
  const withPayload = (message: string) => action('ACTION', message);
  // @dts-jest:pass:snap
  withPayload('Hello!'); // => { type: 'ACTION',payload: 'Hello!' }
}

// @dts-jest:group with optional payload
{
  const withOptionalPayload = (message?: string) => action('ACTION', message);
  // @dts-jest:pass:snap
  withOptionalPayload(); // => { type: 'ACTION' }
  // @dts-jest:pass:snap
  withOptionalPayload('Hello!'); // => { type: 'ACTION', payload: 'Hello!' }
}

// @dts-jest:group with meta
{
  const withMeta = (scope: string) => action('ACTION', undefined, scope);
  // @dts-jest:pass:snap
  withMeta('info'); // => { type: 'ACTION', meta: 'info' }
}

// @dts-jest:group with optional meta
{
  const withOptionalMeta = (scope?: string) =>
    action('ACTION', undefined, scope);
  // @dts-jest:pass:snap
  withOptionalMeta(); // => { type: 'ACTION' }
  // @dts-jest:pass:snap
  withOptionalMeta('info'); // => { type: 'ACTION', meta: 'info' }
}

// @dts-jest:group with payload and meta
{
  const withPayloadAndMeta = (message: string, scope: string) =>
    action('ACTION', message, scope);
  // @dts-jest:pass:snap
  withPayloadAndMeta('Hello!', 'info'); // => { type: 'ACTION', payload: 'Hello!', meta: 'info' }
}

// @dts-jest:group with optional payload and meta
{
  const withOptionalPayloadAndMeta = (scope: string, message?: string) =>
    action('ACTION', message, scope);
  // @dts-jest:pass:snap
  withOptionalPayloadAndMeta('info'); // => { type: 'ACTION', meta: 'info' }
  // @dts-jest:pass:snap
  withOptionalPayloadAndMeta('info', 'Hello!'); // => { type: 'ACTION', payload: 'Hello!', meta: 'info' }
}

// @dts-jest:group with payload and optional meta
{
  const withPayloadAndOptionalMeta = (message: string, scope?: string) =>
    action('ACTION', message, scope);
  // @dts-jest:pass:snap
  withPayloadAndOptionalMeta('Hello!'); // => { type: 'ACTION', payload: 'Hello!' }
  // @dts-jest:pass:snap
  withPayloadAndOptionalMeta('Hello!', 'info'); // => { type: 'ACTION', payload: 'Hello!', meta: 'info' }
}

// @dts-jest:group with optional payload and optional meta
{
  const withOptionalPayloadAndOptionalMeta = (
    message?: string,
    scope?: string
  ) => action('ACTION', message, scope);
  // @dts-jest:pass:snap
  withOptionalPayloadAndOptionalMeta(); // => { type: 'ACTION' }
  // @dts-jest:pass:snap
  withOptionalPayloadAndOptionalMeta('Hello!'); // => { type: 'ACTION', payload: 'Hello!' }
  // @dts-jest:pass:snap
  withOptionalPayloadAndOptionalMeta('Hello!', 'info'); // => { type: 'ACTION', payload: 'Hello!', meta: 'info' }
}

// @dts-jest:group with error
{
  const withError = (error: boolean) =>
    action('ACTION', undefined, undefined, error);
  // @dts-jest:pass:snap
  withError(true); // => { type: 'ACTION', error: true }
}

// @dts-jest:group with optional error
{
  const withOptionalError = (error?: boolean) =>
    action('ACTION', undefined, undefined, error);
  // @dts-jest:pass:snap
  withOptionalError(); // => { type: 'ACTION' }
  // @dts-jest:pass:snap
  withOptionalError(true); // => { type: 'ACTION', error: true }
}

// @dts-jest:group with payload, meta, and error
{
  const withPayloadMetaAndError = (
    message: string,
    scope: string,
    error: boolean
  ) => action('ACTION', message, scope, error);
  // @dts-jest:pass:snap
  withPayloadMetaAndError('Hello!', 'info', true); // => { type: 'ACTION', payload: 'Hello!', meta: 'info', error: true }
}

// @dts-jest:group with payload, meta, and optional error
{
  const withPayloadMetaAndOptionalError = (
    message: string,
    scope: string,
    error?: boolean
  ) => action('ACTION', message, scope, error);
  // @dts-jest:pass:snap
  withPayloadMetaAndOptionalError('Hello!', 'info'); // => { type: 'ACTION', payload: 'Hello!', meta: 'info' }
  // @dts-jest:pass:snap
  withPayloadMetaAndOptionalError('Hello!', 'info', true); // => { type: 'ACTION', payload: 'Hello!', meta: 'info', error: true }
}

// @dts-jest:group with optional payload, optional meta, and optional error
{
  const withOptionalPayloadOptionalMetaAndOptionalError = (
    message?: string,
    scope?: string,
    error?: boolean
  ) => action('ACTION', message, scope, error);
  // @dts-jest:pass:snap
  withOptionalPayloadOptionalMetaAndOptionalError(); // => { type: 'ACTION' }
  // @dts-jest:pass:snap
  withOptionalPayloadOptionalMetaAndOptionalError('Hello!'); // => { type: 'ACTION', payload: 'Hello!' }
  // @dts-jest:pass:snap
  withOptionalPayloadOptionalMetaAndOptionalError('Hello!', 'info'); // => { type: 'ACTION', payload: 'Hello!', meta: 'info' }
  // @dts-jest:pass:snap
  withOptionalPayloadOptionalMetaAndOptionalError('Hello!', 'info', true); // => { type: 'ACTION', payload: 'Hello!', meta: 'info', error: true }
}