SDTF QueryResult

The QueryResult class API reference

The QueryResult class provides an abstraction to work with the tree node returned by a SDTF query.

Properties

isContinuous

Indicates whether the selected nodes are part of the same resulting JSON tree.

get isContinuous(): boolean;

Methods

merge

Produces a new tree state with the resulting nodes.

merge(dedupeFn?: MergeDedupeFn): {
    treeState: TreeState;
};

hasNodeType

Check if the result contains some nodes of the specified type.

hasNodeType(nodeType: 'collection' | 'group' | 'token'): boolean;

hasOnlyNodeType

Check if the result contains only nodes of the specified type.

hasOnlyNodeType(nodeType: 'collection' | 'group' | 'token'): boolean;

render

Produces an analysis of the resulting nodes.

type QueryResultDetail = {
  isRoot: boolean;
  parentPath: Array<string>;
  isComplete: boolean;
  nodes: Array<SDTFNodeState>;
  sdtf: SpecifyDesignTokenFormat;
};
render(): Array<QueryResultDetail>;

When the result is continuous, the render function returns an array of length 1

getPaths

Get the token tree path of the resulting nodes.

getPaths(type: 'string'): Array<string>;
getPaths(type: 'array'): Array<Array<string>>;
getPaths(type?: undefined): Array<string>;

toJSON

Renders the resulting nodes as a JSON object using the QueryResultDetail structure.

toJSON(): {
    isContinuous: boolean;
    graphs: {
        isRoot: boolean;
        parentPath: string[];
        isComplete: boolean;
        sdtf: SpecifyDesignTokenFormat;
    }[];
};