Linear Typescript SDK
Open Source Integrations
Links
Getting Started
The Linear Typescript SDK exposes the Linear GraphQL schema through strongly typed models and operations. It's written in Typescript but can also be used in any Javascript environment.
All operations return models, which can be used to perform operations for other models and all types are accessible through the Linear SDK package.
1
import { LinearClient, LinearFetch, User } from "@linear/sdk";
2
3
const linearClient = new LinearClient({ apiKey });
4
5
async function getCurrentUser(): LinearFetch<User> {
6
return linearClient.viewer;
7
}
Copied!
To quickly try out the SDK, open Javascript console when viewing your Linear workspace. You can load the SDK with your account using
loadLinearClient() command.Connect to the Linear API and interact with your data in a few steps:
1. Install the Linear Client
Using npm:
1
npm install @linear/sdk
Copied!
Or yarn:
1
yarn add @linear/sdk
Copied!
2. Create a Linear client
SDK supports both authentication methods, personal API keys and OAuth 2. See authentication for more details.
You can create a client after creating authentication keys:
1
import { LinearClient } from '@linear/sdk'
2
3
// Api key authentication
4
const client1 = new LinearClient({
5
apiKey: YOUR_PERSONAL_API_KEY
6
})
7
8
// OAuth2 authentication
9
const client2 = new LinearClient({
10
accessToken: YOUR_OAUTH_ACCESS_TOKEN
11
})
Copied!
3. Query for your issues
Using async await syntax:
1
async function getMyIssues() {
2
const me = await linearClient.viewer;
3
const myIssues = await me.assignedIssues();
4
5
if (myIssues.nodes.length) {
6
myIssues.nodes.map(issue => console.log(`${me.displayName} has issue: ${issue.title}`));
7
} else {
8
console.log(`${me.displayName} has no issues`);
9
}
10
}
11
12
getMyIssues();
Copied!
Or promises:
1
linearClient.viewer.then(me => {
2
return me.assignedIssues().then(myIssues => {
3
if (myIssues.nodes.length) {
4
myIssues.nodes.map(issue => console.log(`${me.displayName} has issue: ${issue.title}`));
5
} else {
6
console.log(`${me.displayName} has no issues`);
7
}
8
});
9
});
Copied!