prioritized.grouping/docs/shinylive/webr/webR/robj.d.ts

/**
 * Common module for working with R objects.
 * @module RObject
 */
import * as RMain from './robj-main';
import * as RWorker from './robj-worker';
export type RPtr = number;
export declare const RTypeMap: {
    readonly null: 0;
    readonly symbol: 1;
    readonly pairlist: 2;
    readonly closure: 3;
    readonly environment: 4;
    readonly promise: 5;
    readonly call: 6;
    readonly special: 7;
    readonly builtin: 8;
    readonly string: 9;
    readonly logical: 10;
    readonly integer: 13;
    readonly double: 14;
    readonly complex: 15;
    readonly character: 16;
    readonly dots: 17;
    readonly any: 18;
    readonly list: 19;
    readonly expression: 20;
    readonly bytecode: 21;
    readonly pointer: 22;
    readonly weakref: 23;
    readonly raw: 24;
    readonly s4: 25;
    readonly new: 30;
    readonly free: 31;
    readonly function: 99;
};
export type RType = keyof typeof RTypeMap;
export type RTypeNumber = (typeof RTypeMap)[keyof typeof RTypeMap];
export type Complex = {
    re: number;
    im: number;
};
export type WebRDataRaw = number | string | boolean | undefined | null | void | Complex | Error | ArrayBuffer | ArrayBufferView | Array<WebRDataRaw> | Map<WebRDataRaw, WebRDataRaw> | Set<WebRDataRaw> | {
    [key: string]: WebRDataRaw;
};
export type NamedEntries<T> = [string | null, T][];
export type NamedObject<T> = {
    [key: string]: T;
};
/**
 * A union of JavaScript types that are able to be converted into an R object.
 *
 * `WebRData` is used both as a general input argument for R object construction
 * and also as a general return type when converting R objects into JavaScript.
 *
 */
export type WebRData = RMain.RObject | RWorker.RObjectBase | RWorker.RObject | WebRDataRaw | WebRDataJs | WebRData[] | {
    [key: string]: WebRData;
};
/**
 * A subset of {@link WebRData} for JavaScript objects that can be converted
 * into R atomic vectors.
 * @typeParam T The JavaScript scalar type associated with the atomic vector.
 */
export type WebRDataAtomic<T> = WebRDataScalar<T> | (T | null)[] | WebRDataJsAtomic<T> | NamedObject<T | null>;
/**
 * `WebRDataJs` objects form a tree structure, used when serialising R objects
 * into a JavaScript respresentation.
 *
 * Nested R objects are serialised using the {@link WebRDataJsNode} type,
 * forming branches in the resulting tree structure, with leaves formed by the
 * remaining types.
 */
export type WebRDataJs = WebRDataJsNull | WebRDataJsString | WebRDataJsSymbol | WebRDataJsNode | WebRDataJsAtomic<RWorker.atomicType>;
export type WebRDataJsNull = {
    type: 'null';
};
export type WebRDataJsString = {
    type: 'string';
    value: string;
};
export type WebRDataJsSymbol = {
    type: 'symbol';
    printname: string | null;
    symvalue: RPtr | null;
    internal: RPtr | null;
};
export type WebRDataJsNode = {
    type: 'list' | 'pairlist' | 'environment';
    names: (string | null)[] | null;
    values: (WebRDataRaw | RWorker.RObject | RMain.RObject | WebRDataJs)[];
};
export type WebRDataJsAtomic<T> = {
    type: 'logical' | 'integer' | 'double' | 'complex' | 'character' | 'raw';
    names: (string | null)[] | null;
    values: (T | null)[];
};
/**
 * Test for a {@link WebRDataJs} instance.
 * @param {any} value The object to test.
 * @returns {boolean} True if the object is an instance of a {@link WebRDataJs}.
 */
export declare function isWebRDataJs(value: any): value is WebRDataJs;
/**
 * A subset of WebRData for scalar JavaScript objects.
 */
export type WebRDataScalar<T> = T | RMain.RObject | RWorker.RObjectBase;
/**
 * Test if an object is of type {@link Complex}.
 * @param {any} value The object to test.
 * @returns {boolean} True if the object is of type {@link Complex}.
 */
export declare function isComplex(value: any): value is Complex;