![\"Gregor](\"https://avatars.githubusercontent.com/u/39992?v=4?s=100\")
Gregor Martynus
🤔 💻 ⚠️ 👀 🚧 🚇
![\"Mike](\"https://avatars.githubusercontent.com/u/821435?v=4?s=100\")
Mike Surowiec
💻 ⚠️
![\"Tom](\"https://avatars.githubusercontent.com/u/13594679?v=4?s=100\")
Tom Elliott
💻 ⚠️ 👀
![\"Sam](\"https://avatars.githubusercontent.com/u/456807?v=4?s=100\")
Sam Lin
💻 ⚠️
![\"Evan](\"https://avatars.githubusercontent.com/u/17055832?v=4?s=100\")
Evan Bonsignori
💻 ⚠️ 📖
![\"Baptiste](\"https://avatars.githubusercontent.com/u/17877656?v=4?s=100\")
Baptiste Lombard
💻 ⚠️
| \nBrowsers\n | \nLoad github-project directly from cdn.skypack.dev\n\n```html\n\n```\n\n |
|---|---|
| \nNode\n | \n\nInstall with npm install github-project\n\n```js\nimport GitHubProject from \"github-project\";\n```\n\n |
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n options.owner\n | \n \n string\n | \n \n\n**Required**. The account name of the GitHub organization.\n\n | \n
\n options.number\n | \n \n Number\n | \n \n\n**Required**. Project number as you see it in the URL of the project.\n\n | \n
\n options.token\n | \n \n String\n | \n \n\n**Required unless `options.octokit` is set**. When set to a personal access token or an OAuth token, the `read:org` scope is required for read-only access, and the `write:org` scope is required for read-write access. When set to an installation access token, the `organization_projects:read` permission is required for read-only access, and the `organization_projects:write` permission is required for read-write access.\n\n |
\n options.octokit\n | \n \n Octokit\n | \n \n\n**Required unless `options.token` is set**. You can pass an [`@octokit/core`](https://github.com/octokit/core.js/#readme) instance, or an instance of any `Octokit` class that is built upon it, such as [`octokit`](https://github.com/octokit/octokit.js/#readme).\n\n | \n
\n options.fields\n | \n \n Object\n | \n \n\n**Required**. A map of internal names for fields to the column names or field option objects. The `title` key will always be set to `\"Title\"` and `status` to `\"Status\"` to account for the built-in fields. The other built-in columns `Assignees`, `Labels`, `Linked Pull Requests`, `Milestone`, `Repository`, and `Reviewers` cannot be set through the project and are not considered fields. You have to set them on the issue or pull request, and you can access them by `item.content.assignees`, `item.content.labels` etc (for both issues and pull requests).\n\nA field option object must include a `name` key and can include an `optional` key.\n\nWhen `optional` is `false` or omitted, an error will be thrown if the field is not found in the project. When `optional` is `true`, the error will be replaced by an `info` log via the [Octokit Logger](https://octokit.github.io/rest.js/v18#logging). Optional fields that don't exist in the project are not set on items returned by the `project.items.*` methods.\n\n | \n
\n options.matchFieldName\n | \n \n Function\n | \n \n\nCustomize how field names are matched with the values provided in `options.fields`. The function accepts two arguments:\n\n1. `projectFieldName`\n2. `userFieldName`\n\nBoth are strings. Both arguments are lower-cased and trimmed before passed to the function. The function must return `true` or `false`.\n\nDefaults to\n\n```js\nfunction (projectFieldName, userFieldName) {\n return projectFieldName === userFieldName\n}\n```\n\n | \n
\n options.matchFieldOptionValue\n | \n \n Function\n | \n \n\nCustomize how field options are matched with the field values set in `project.items.add()`, `project.items.addDraft()`, or `project.items.update*()` methods. The function accepts two arguments:\n\n1. `fieldOptionValue`\n2. `userValue`\n\nBoth are strings. Both arguments are trimmed before passed to the function. The function must return `true` or `false`.\n\nDefaults to\n\n```js\nfunction (fieldOptionValue, userValue) {\n return fieldOptionValue === userValue\n}\n```\n\n | \n
\n options.truncate\n | \n \n Function\n | \n \n\nText field values cannot exceed 1024 characters. By default, the `options.truncate` just returns text as is. We recommend to use an establish truncate function such as [loadsh's `_.truncate()`](https://lodash.com/docs/4.17.15#truncate), as byte size is not the same as text length.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n content.title\n | \n \n string\n | \n \n\n**Required**. The title of the issue draft.\n\n | \n
\n content.body\n | \n \n string\n | \n \n\nThe body of the issue draft.\n\n | \n
\n content.assigneeIds\n | \n \n string[]\n | \n \n\nNode IDs of user accounts the issue should be assigned to when created.\n\n | \n
\n fields\n | \n \n object\n | \n \n\nMap of internal field names to their values.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n contentId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the issue or pull request you want to add.\n\n | \n
\n fields\n | \n \n object\n | \n \n\nMap of internal field names to their values.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n itemNodeId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the project item\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n contentId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the issue/pull request the item is linked to.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n repositoryName\n | \n \n string\n | \n \n\n**Required**. The repository name, without the `owner/`.\n\n | \n
\n issueOrPullRequestNumber\n | \n \n number\n | \n \n\n**Required**. The number of the issue or pull request.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n itemNodeId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the project item\n\n | \n
\n fields\n | \n \n object\n | \n \n\nMap of internal field names to their values.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n contentId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the issue/pull request the item is linked to.\n\n | \n
\n fields\n | \n \n object\n | \n \n\nMap of internal field names to their values.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n repositoryName\n | \n \n string\n | \n \n\n**Required**. The repository name, without the `owner/`.\n\n | \n
\n issueOrPullRequestNumber\n | \n \n number\n | \n \n\n**Required**. The number of the issue or pull request.\n\n | \n
\n fields\n | \n \n object\n | \n \n\nMap of internal field names to their values.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n itemNodeId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the project item\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n contentId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the issue/pull request the item is linked to.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n repositoryName\n | \n \n string\n | \n \n\n**Required**. The repository name, without the `owner/`.\n\n | \n
\n issueOrPullRequestNumber\n | \n \n number\n | \n \n\n**Required**. The number of the issue or pull request.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n itemNodeId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the project item\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n contentId\n | \n \n string\n | \n \n\n**Required**. The graphql node ID of the issue/pull request the item is linked to.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n repositoryName\n | \n \n string\n | \n \n\n**Required**. The repository name, without the `owner/`.\n\n | \n
\n issueOrPullRequestNumber\n | \n \n number\n | \n \n\n**Required**. The number of the issue or pull request.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n name\n | \n \n constant\n | \n GitHubProjectNotFoundError | \n
\n message\n | \n \n constant\n | \n \n\n> Project cannot be found\n\n | \n
\n details\n | \n \n object\n | \n \n\nObject with error details\n\n | \n
\n details.owner\n | \n \n string\n | \n \n\nLogin of owner of the project\n\n | \n
\n details.number\n | \n \n number\n | \n \n\nNumber of the project\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n name\n | \n \n constant\n | \n GitHubProjectUnknownFieldError | \n
\n message\n | \n \n constant\n | \n \n\n> Project field cannot be found\n\n | \n
\n details\n | \n \n object\n | \n \n\nObject with error details\n\n | \n
\n details.projectFieldNames\n | \n \n string[]\n | \n \n\nNames of all project fields as shown in the project\n\n | \n
\n details.userFieldName\n | \n \n object\n | \n \n\nName of the field provided by the user\n\n | \n
\n details.userFieldNameAlias\n | \n \n object\n | \n \n\nAlias of the field name provided by the user\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n name\n | \n \n constant\n | \n GitHubProjectInvalidValueError | \n
\n message\n | \n \n constant\n | \n \n\n> User value is incompatible with project field type\n\n | \n
\n details\n | \n \n object\n | \n \n\nObject with error details\n\n | \n
\n details.field\n | \n \n object\n | \n \n\nObject with field details\n\n | \n
\n details.field.id\n | \n \n string\n | \n \n\n`details.field.id` is the project field GraphQL node ID\n\n | \n
\n details.field.name\n | \n \n string\n | \n \n\nThe field name as shown in the project\n\n | \n
\n details.field.type\n | \n \n string\n | \n \n\nIs always either `DATE`, `NUMBER`, or `SINGLE_SELECT`. If it's `SINGLE_SELECT`, then the error is a [`GitHubProjectUnknownFieldOptionError`](#githubprojectunknownfieldoptionerror).\n\n | \n
\n details.userValue\n | \n \n string\n | \n \n\nThe stringified value set in the API call.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n name\n | \n \n constant\n | \n GitHubProjectUnknownFieldOptionError | \n
\n message\n | \n \n constant\n | \n \n\n> Project field option cannot be found\n\n | \n
\n details\n | \n \n object\n | \n \n\nObject with error details\n\n | \n
\n details.field\n | \n \n object\n | \n \n\nObject with field details\n\n | \n
\n details.field.id\n | \n \n string\n | \n \n\n`details.field.id` is the project field GraphQL node ID\n\n | \n
\n details.field.name\n | \n \n string\n | \n \n\nThe field name as shown in the project\n\n | \n
\n details.field.type\n | \n \n constant\n | \n \n\n`SINGLE_SELECT`\n\n | \n
\n details.field.options\n | \n \n object[]\n | \n \n\nArray of objects with project field details\n\n | \n
\n details.field.options[].id\n | \n \n string\n | \n \n\nThe GraphQL node ID of the option\n\n | \n
\n details.field.options[].name\n | \n \n string\n | \n \n\nThe option name as shown in the project.\n\n | \n
\n details.userValue\n | \n \n string\n | \n \n\nThe stringified value set in the API call.\n\n | \n
| \n name\n | \n\n type\n | \n\n description\n | \n
|---|---|---|
\n name\n | \n \n constant\n | \n GitHubProjectUpdateReadOnlyFieldError | \n
\n message\n | \n \n constant\n | \n \n\n> Project read-only field cannot be updated\n\n | \n
\n details\n | \n \n object\n | \n \n\nObject with error details\n\n | \n
\n details.fields\n | \n \n object[]\n | \n \n\nArray of objects with read-only fields and their user-provided values\n\n | \n
\n details.fields[].id\n | \n \n string\n | \n \n\nGraphQL node ID of the project field\n\n | \n
\n details.fields[].name\n | \n \n string\n | \n \n\nThe project field name\n\n | \n
\n details.fields[].userName\n | \n \n string\n | \n \n\nThe user-provided alias for the project field\n\n | \n
\n details.fields[].userValue\n | \n \n string\n | \n \n\nThe user provided value that the user attempted to set the field to.\n\n | \n
Gregor Martynus 🤔 💻 ⚠️ 👀 🚧 🚇 | \n Mike Surowiec 💻 ⚠️ | \n Tom Elliott 💻 ⚠️ 👀 | \n Sam Lin 💻 ⚠️ | \n Evan Bonsignori 💻 ⚠️ 📖 | \n Baptiste Lombard 💻 ⚠️ | \n