nflow/src/consts.js

event/data/control flow

export const UNSET = {}

/**
 * Enum for the direction event propagation
 * @enum {String}
 * @readonly
 * @name DIRECTION
 * @property {String} CURRENT - the event is only propagated to the current node
 * @property {String} DEFAULT - the event bubbles up to root parent(the parent that has no other parents), then traverses **depth-first** to all child nodes
 * @property {String} UPSTREAM - The event bubbles up to the root node
 * @property {String} DOWNSTREAM - the event traverses **depth-first** all child nodes
 */
export const DIRECTION = {
  CURRENT: 'CURRENT',
  NONE: 'CURRENT', // deprecated
  DEFAULT: 'DEFAULT',
  UPSTREAM: 'UPSTREAM',
  DOWNSTREAM: 'DOWNSTREAM'
}

export const DIRECTION_BITMASK = {
  CURRENT: 1 << 0,
  NONE: 1 << 0, // 1 deprecated
  DEFAULT: 1 << 1, // 2
  UPSTREAM: 1 << 2, // 4
  DOWNSTREAM: 1 << 3 // 8
}

/**
 * Enum for decribing the status of a flow node.
 *
 * Use {@link flow.status}() to get the status of a flow instance.
 * @enum
 * @readonly
 * @property {String} ACTIVE (Default) The node can emit(or be emitted), propagate or listen to events.
 * @property {String} FLOWING The node has been emitted(so it is now treated as an event), but it hasn't been delivered to all listeners yet.
 * @property {String} STOPPED The event propagation was stopped. See {@link flow.stopPropagation}
 * @property {String} COMPLETED The event has been propagated to all listeners.
 * @property {String} CANCELLED The event has been cancelled. See {@link flow.cancel}
 * @property {String} DISPOSED The event has been disposed. See {@link flow.dispose}
 */
export const STATUS = {
  IDLE: 'IDLE',
  FLOWING: 'FLOWING',
  STOPPED: 'STOPPED',
  COMPLETED: 'COMPLETED',
  CANCELLED: 'CANCELLED',
  DISPOSED: 'DISPOSED'
}

export const DEFAULTS = {
  factory: () => ({}),
  behaviours: [
    'identify',
    'stateful',
    'connect',
    'create',
    'disposable',
    'emit',
    'listen',
    'cancellable',
    'loggable',
    'stats',
    'namespace'
  ],
  direction: DIRECTION.DEFAULT
}
export const ERRORS = {
  invalidGuid: 'Invalid Argument. Guid-s are immutable. Please use the .name() API to change the name of a flow object.',
  invalidChildren: 'Invalid Argument. Please use child.parent(parent) to re-parent flow objects.',
  invalidListener: 'Invalid Arguments. Expected a String as the listenerName, got: %s',
  invalidListenerType: 'Invalid Listener function. Expected a function, got: %s',
  invalidEventName: 'Invalid Arguments. Please use .emit("foo", payload) to emit a flow event.',
  invalidName: 'Invalid flow Name. Expected a String value, got: %s',
  invalidParent: 'Invalid flow parent object. Expected a flow instance, got: %s',
  invalidParents: 'Invalid Argument. Please use the child.parent(parent) API to re-parent flow objects.',
  invalidStatus: 'Invalid Argument. The .status() API is read only',
  invalidNamespaceArgs: 'Invalid Argument. The .namespace() API is read only',
  invalidFullNamespace: 'Invalid Argument. The .namespace.match(full_ns) requires a full namespace array, got: %s',
  invalidDisposeArgs: 'Invalid Argument. The .dispose() API requires no parameters',
  invalidCancelArgs: 'Invalid Argument. The .cancel() API requires no parameters',
  invalidStopPropagationArgs: 'Invalid Argument. The .stopPropagation(direction) API requires either no parameters or a valid flow direction(eg. flow.direction.UPSTREAM)',
  invalidStopPropagationAugmentation: 'Invalid Argument. The .stopPropagation(direction) API can only be used on emitted events.',
  invalidRoot: 'Invalid Argument. The .parents.root() API is read only',
  invalidStatsArgs: 'Invalid Argument. The .stats() API requires an object'
}

export const NS_SEPARATOR = ':'