WorkspaceSDK
API reference
An installed SDK: a module marked for scaffolding other modules and clients.
Implements Node
id: ID!
A unique identifier for this WorkspaceSDK.
name: String!
The user-facing SDK name.
ref: String!
The module reference this SDK was installed from.
clients: [WorkspaceModule!]!
Clients generated with this SDK.
modules: [WorkspaceModule!]!
Modules authored with this SDK.
scopeSetting(path: String!, key: String!): JSONValue
The value a setting records in this SDK's scope settings, as a native JSON value.
Reads [sdks.<name>.scopes."<scope>".settings] from the workspace config, in the scope whose key resolves to path. The setting key is matched without regard to case.
Null when no scope resolves to path, or the scope records no such setting. Fails when the config is invalid, path escapes the workspace root, key matches several recorded settings, or the value cannot be represented as JSON.
Fails when this SDK is no longer installed in the workspace config, even if Workspace.sdk returned it earlier.
path: String!Scope path, relative to the workspace cwd or absolute from the workspace root.
key: String!Setting name, matched without regard to case.