@connectv/core/dist/es5/agent/sequence.d.ts

agent-based reactive programming library for typescript/javascript

import { Emission } from '../shared/emission';
import { Control } from '../pin/control';
import { Agent } from './agent';
/**
 *
 * Denotes a token specifying an event sequence.
 * Each token can at each step either accept a new emission,
 * and can complete on a list of emissions.
 *
 */
export interface SequenceToken {
    /**
     *
     * Determines whether the token would accept the new incoming emission
     * (i.e. it could still be satisfied in the future if this emission was accepted),
     * based on the emission itself and the list of emissions without the newly arrived emission.
     *
     * @param val the newly arrived emission
     * @param list the already accepted list of emissions
     *
     */
    accepts(val: Emission, list: Emission[]): boolean;
    /**
     *
     * Determines whether the token can be considered completed, i.e.
     * the current list of emissions satisfies its conditions.
     *
     * @param list
     *
     */
    complete(list: Emission[]): boolean;
}
/**
 *
 * Creates a sequence token that denotes events happening between `min` and
 * `max` number of times.
 *
 * @param min the minimum number of times the event should happen
 * @param max the maximum number of times the event should happen
 *
 */
export declare function range(min: number, max?: number): SequenceToken;
/**
 *
 * Creates a sequence token that denotes events happening a
 * specified number of times exactly
 *
 * @param c the number of times the event should happen.
 *
 */
export declare function count(c: number): SequenceToken;
/**
 *
 * Sequence token denoting an event that may or may not happen (multiple times).
 *
 */
export declare const maybesome: SequenceToken;
/**
 *
 * Sequence token denoting an event that happens at least once.
 *
 */
export declare const some: SequenceToken;
export declare type SequenceTokenIndicator = number | '*' | '+' | SequenceToken;
/**
 *
 * Represents [sequence](https://connective.dev/docs/sequence) agents.
 *
 */
export declare class Sequence extends Agent {
    readonly tokens: SequenceToken[];
    private _control;
    private _relay;
    _seq: Emission[][];
    private _head;
    /**
     *
     * @param tokens the tokens denoting the sequence of desired events. Each token must be
     * - A `SequenceToken`,
     * - A number, meaning that an event should happen that number of times exactly,
     * - `'+'` meaning the event should happen at least once,
     * - `'*'` meaning the event may or may not happen one or multiple times.
     *
     */
    constructor(tokens: SequenceTokenIndicator[]);
    private _take;
    private _seek;
    private get _complete();
    protected reset(): this;
    protected createOutput(label: string): import("..").PinLike;
    protected createEntries(): import("..").PinLike[];
    protected createExits(): import("..").PinLike[];
    clear(): this;
    /**
     *
     * Resets the sequence being tracked when receiving emissions
     * on `.control`.
     *
     */
    get control(): Control;
    /**
     *
     * Shortcut for `.out('out')`, which will emit completed sequences.
     * [Read this](https://connective.dev/docs/sequence#signature) for more details.
     *
     */
    get output(): import("..").PinLike;
}
/**
 *
 * Creates a [sequence](https://connective.dev/docs/sequence) agent.
 * Sequence agents can determine if a specific sequence of events has occured.
 * [Checkout the docs](https://connective.dev/docs/sequence) for examples and further information.
 *
 * @param tokens the tokens denoting the sequence of desired events. Each token must be
 * - A `SequenceToken`,
 * - A number, meaning that an event should happen that number of times exactly,
 * - `'+'` meaning the event should happen at least once,
 * - `'*'` meaning the event may or may not happen one or multiple times.
 *
 */
export declare function sequence(...tokens: SequenceTokenIndicator[]): Sequence;
export default sequence;