vega-typings/types/spec/signal.d.ts

Typings for Vega.

import { Binding, Expr, OnEvent } from '../index.js';

// Hide from Vega-Lite schema (Since @hidden isn't used by Vega, we can just add it here for now.)
/**
 * @hidden
 */
export interface SignalRef {
  signal: string;
}
export interface BaseSignal {
  name: string;
  description?: string;
  on?: OnEvent[];
}
export interface PushSignal extends BaseSignal {
  push: 'outer';
}
export interface NewSignal extends BaseSignal {
  value?: SignalValue;
  react?: boolean;
  update?: Expr;
  bind?: Binding;
}
export interface InitSignal extends BaseSignal {
  value?: SignalValue;
  init: Expr;
  bind?: Binding;
}
export type Signal = NewSignal | InitSignal | PushSignal;
export type SignalValue = any;