SpecifyClient
The main Specify client to interact with Specify repositories and the SDTF token tree.
Properties
isAuthenticated
A boolean indicating whether the client is authenticated or not.
Methods
authenticate
Authenticates the client with a Personal Access Token. Can be generated at specifyapp.com/user/personal-access-tokens
authenticate(personalAccessToken: string): Promise<void>;
whoAmI
Returns the current user if authenticated.
whoAmI(): {
email: string;
id: string;
username: string;
fullname: string;
organizations: {
id: string;
namespace: string;
domain: string | null;
}[];
} | null;
logout
Logs out the current user.
logout(): void;
getRepositories
Returns the repositories list of the current organization.
getRepositories(): Promise<{
name: string;
id: string;
version: number;
createdAt: string;
updatedAt: string;
}[]>;
getSDTFClientByRepositoryName
Returns a SDTFClient instance to work with the SDTF token tree of the repository.
getSDTFClientByRepositoryName(repositoryName: string): Promise<SDTFClient>;
transformTokenTreeWithRemoteParsers
Generates Design Tokens from the given token tree and configuration parsers.
transformTokenTreeWithRemoteParsers(
sdtfTree: SpecifyDesignTokenFormat,
parsers: PipeEngineParserConfiguration
): Promise<{
fromRule: string;
output: PipeEngineRuleOutput
}>;
Last updated
Was this helpful?