SDTF Client

Step into the Specify SDK APIs to get fined grained access to your design data.

Introduction

The Parsers Engine produces finite and opinionated outputs, but sometimes you need to have more control over our generated files.

That's where the SDTF Client takes over and provide plenty of methods to work with any SDTF token tree.

Looking for how to get started with the SDK? 👉 heads up to the Specify SDK usage 101 guide.

Overview

The SDTF Client offers versatile methods for working with SDTF token trees, enabling data manipulation, transformation, and conversion into various formats or languages, bridging the gap between stored and live token instances within your repository.

To access your organization data, you use the Specify Client API. You can then fetch a repository and use the SDTF Client API to manipulate the data and transform to your desired custom format.

The SDTF Client API wraps up the SDTF Engine which holds the lower level methods to work with the token tree.

The Specify Client API

The Specify Client manages:

• your authentication credentials - personal access token

• your access to your organization repositories

The SDTF Client API

The SDTF Client bridges the gap between the raw token tree stored into your repository - in Specify database - and the live token tree instance provided by the SDK.

Mutate the token tree locally

Since the client is instantiated locally, all changes made to the token tree are only affecting the current version of the client.

You can create several instances of the same initial token tree - using clone()

Then, create several updates:

• with predefined formatters using update()

• with cherry-picking of a sub-tree using pick()

• with custom implementation using forEachTokenState()

• and many more

Convert tokens to XXX

Converting tokens is always a matter of iterating over the tokens of your tree and decide what to do with their value(s), their modes and potential aliases.

Looking for usage? 👉 heads up to the Convert a token to XXX guide.