Interfaces
EnableOpts
Options for enableWorkspaces.
Extends
Section titled “Extends”Properties
Section titled “Properties”acceptTerms?
Section titled “acceptTerms?”
optionalacceptTerms?:boolean
Accept, on the organization’s behalf, the legal documents it has not accepted yet. Pass true only when the person running your program has read and agreed to them (workspacesStatus() lists them, with URLs). Without it, an organization with unaccepted terms rejects with TermsNotAcceptedError.
githubAccount?
Section titled “githubAccount?”
optionalgithubAccount?:string
The GitHub organization or user to link (default: the GitHub user who authorizes in the browser).
githubPort?
Section titled “githubPort?”
optionalgithubPort?:number
The loopback port for GitHub’s redirect (default 8989).
instance?
Section titled “instance?”
optionalinstance?:string
The organization ID. If unset, $CHAINCTL_SANDBOX_INSTANCE is used, and failing that the only organization you belong to.
Inherited From
Section titled “Inherited From”openBrowser?
Section titled “openBrowser?”
optionalopenBrowser?:boolean
false: don’t start the GitHub authorization; reject with GitHubLinkRequiredError if a link is needed.
openUrl?
Section titled “openUrl?”
optionalopenUrl?: (url) =>boolean|void|Promise<boolean|void>
Opens the GitHub page instead of the default browser launcher.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean | void | Promise<boolean | void>
optionalout?: (message) =>void
Receives instructions during the GitHub authorization (default: written to stderr).
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
tokenSource?
Section titled “tokenSource?”
optionaltokenSource?:TokenSource
Mints tokens for the platform API (default: the saved login).
