SDTF Engine

The SDTF Engine API reference.

Instances

The SDTF Engine can be accessed in:

• the @specifyapp/sdk package, by using the specifyClient.getRepositoryTokenTree method.

• the @specifyapp/specify-design-token-format package, by using the exported createSDTFEngine function.

Public API

sdtfEngine.[method]

Query methods

The Query API provides methods for locally accessing and iterating the token tree.

Query runner

The SDTF Query Language is used into the sdtfEngine.query.run(query: SDTFQuery)

Mutation methods

The Mutation API provides methods for locally mutating the token tree.

Top level

renderJSONTree

Get the JSON representation of the token tree.

function renderJSONTree(param: {
  renderOptions:
    | {
        resolveAliases: true;
        allowUnresolvable?: AllowUnresolvable;
        targetMode?: TargetMode;
      }
    | { resolveAliases: false };
}): JSON;