{"id":15020081,"url":"https://github.com/wsmd/github-profile-status","last_synced_at":"2025-10-25T00:30:41.863Z","repository":{"id":34414204,"uuid":"178498657","full_name":"wsmd/github-profile-status","owner":"wsmd","description":":octocat: Update the status of your GitHub profile programmatically","archived":false,"fork":false,"pushed_at":"2023-01-05T00:46:25.000Z","size":979,"stargazers_count":61,"open_issues_count":13,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-31T04:31:54.779Z","etag":null,"topics":["automation","github","github-profile","github-status"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wsmd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-30T01:57:25.000Z","updated_at":"2025-01-16T18:44:27.000Z","dependencies_parsed_at":"2023-01-15T07:01:01.581Z","dependency_job_id":null,"html_url":"https://github.com/wsmd/github-profile-status","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wsmd%2Fgithub-profile-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wsmd%2Fgithub-profile-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wsmd%2Fgithub-profile-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wsmd%2Fgithub-profile-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wsmd","download_url":"https://codeload.github.com/wsmd/github-profile-status/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238046851,"owners_count":19407625,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","github","github-profile","github-status"],"created_at":"2024-09-24T19:54:33.835Z","updated_at":"2025-10-25T00:30:41.475Z","avatar_url":"https://github.com/wsmd.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# github-profile-status \u003c!-- omit in toc --\u003e\n\n[![Current Release](https://img.shields.io/npm/v/github-profile-status.svg)](https://www.npmjs.com/package/github-profile-status)\n[![CI Build](https://travis-ci.org/wsmd/github-profile-status.svg?branch=master)](https://travis-ci.org/wsmd/github-profile-status)\n[![Coverage Status](https://coveralls.io/repos/github/wsmd/github-profile-status/badge.svg?branch=master)](https://coveralls.io/github/wsmd/github-profile-status?branch=master)\n[![Licence](https://img.shields.io/github/license/wsmd/github-profile-status.svg)](https://github.com/wsmd/github-profile-status/blob/master/LICENSE)\n\n\u003c/div\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e📖 Table of Contents\u003c/summary\u003e\n\u003cp\u003e\n\n- [Motivation](#motivation)\n- [Installation](#installation)\n- [Example](#example)\n- [API](#api)\n  - [Constructor](#constructor)\n    - [`new GitHubProfileStatus(options: ConstructorOptions)`](#new-githubprofilestatusoptions-constructoroptions)\n    - [Constructor Options](#constructor-options)\n  - [Methods](#methods)\n    - [`get(): Promise\u003cUserStatus | null\u003e`](#get-promiseuserstatus--null)\n    - [`getForUser(username?: string): Promise\u003cUserStatus | null\u003e`](#getforuserusername-string-promiseuserstatus--null)\n    - [`set(status: ChangeUserStatusInput): Promise\u003cUserStatus | null\u003e`](#setstatus-changeuserstatusinput-promiseuserstatus--null)\n    - [`update(status: ChangeUserStatusInput): Promise\u003cUserStatus | null\u003e`](#updatestatus-changeuserstatusinput-promiseuserstatus--null)\n    - [`clear(): Promise\u003cboolean\u003e`](#clear-promiseboolean)\n  - [`ChangeUserStatusInput`](#changeuserstatusinput)\n  - [`UserStatus`](#userstatus)\n- [Licence](#licence)\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n## Motivation\n\nGitHub introduced a [new feature](https://github.blog/changelog/2019-01-09-set-your-status/) that allows you to set your status on your profile!\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/2100222/55207714-ba68c380-51b1-11e9-9283-d11e4265a827.png\" width=\"482\" /\u003e\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003c/div\u003e\n\nThis library gives you the ability to programmatically update your GitHub profile status. With this, you can do really interesting stuff, like [displaying what you're listening to](https://github.com/wsmd/github-now-playing) right on GitHub! The possibilities are endless!\n\n## Installation\n\nThis library is available on the [npm](https://www.npmjs.com/package/github-profile-status) registry as a [node](https://nodejs.org/en/) module and can be installed by running:\n\n```sh\n# via npm\nnpm install --save github-profile-status\n\n# via yarn\nyarn add github-profile-status\n```\n\n## Example\n\n```js\nimport { GitHubProfileStatus } from 'github-profile-status';\n\nasync function main() {\n  const profileStatus = new GitHubProfileStatus({\n    token: process.env.GITHUB_ACCESS_TOKEN,\n  });\n\n  // set your the github profile status\n  await profileStatus.set({\n    emoji: ':wave:',\n    message: 'Hello, world!',\n    limitedAvailability: true,\n  });\n\n  // update your the github profile status\n  await profileStatus.update({\n    message: 'Howdy!',\n  });\n\n  // get your github profile status\n  const status = await profileStatus.get();\n\n  // clears your github profile status\n  const success = await profileStatus.clear();\n}\n```\n\n## API\n\n### Constructor\n\n#### `new GitHubProfileStatus(options: ConstructorOptions)`\n\nCreates a new github profile status instance.\n\n#### Constructor Options\n\nAn object with the following keys:\n\n- `token: string`: a [personal access token](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) with the **user** scope.\n\n### Methods\n\nInstances have the following methods:\n\n#### `get(): Promise\u003cUserStatus | null\u003e`\n\nRetrieves the status of the authenticated user.\n\nReturns a Promise that resolves with the [user status](#userstatus) object, or `null` if the user does not have a status set.\n\n#### `getForUser(username?: string): Promise\u003cUserStatus | null\u003e`\n\nRetrieves the status of the provided user.\n\nReturns a Promise that resolves with the [user status](#userstatus) object, or `null` if the user does not have a status set.\n\n#### `set(status: ChangeUserStatusInput): Promise\u003cUserStatus | null\u003e`\n\nSets the user status using the provided [`status`](#changeuserstatusinput).\n\nNote that attributes omitted from `status` will be cleared. If you only want to update the specified attributes without affecting any existing ones, consider using the [`update()`](#updatestatus-changeuserstatusinput-promiseuserstatus--null) method instead.\n\nReturns a Promise that resolves with the [user status](#userstatus) object, or `null` if the status was cleared (e.g. providing an empty message).\n\n#### `update(status: ChangeUserStatusInput): Promise\u003cUserStatus | null\u003e`\n\nPartially updates the status with the provided attributes. All attributes of [`status`](#changeuserstatusinput) are optional. Attributes omitted from the `status` object will remain as they are.\n\nReturns a Promise that resolves with the [user status](#userstatus) object, or `null` if the status was cleared (e.g. providing empty attributes).\n\n#### `clear(): Promise\u003cboolean\u003e`\n\nClears the user profile status.\n\nReturns a Promise that resolves to a boolean indicating a successful operation.\n\n### `ChangeUserStatusInput`\n\n```ts\ninterface ChangeUserStatusInput {\n  /**\n   * The emoji to represent your status. Can either be a native Unicode emoji or\n   * an emoji name with colons, e.g., :wave:\n   */\n  emoji?: string | null;\n  /**\n   * If set, the user status will not be shown after this date. The value can be\n   * either a Date object or an ISO-8601 encoded UTC date string.\n   */\n  expiresAt?: Date | string | null;\n  /**\n   * Whether this status should indicate you are not fully available on GitHub,\n   * e.g., you are away.\n   */\n  limitedAvailability?: boolean;\n  /**\n   * A short description of your current status.\n   */\n  message?: string | null;\n}\n```\n\n### `UserStatus`\n\nThe status object has the following keys:\n\n```ts\ninterface UserStatus {\n  /**\n   * An emoji summarizing the user's status.\n   */\n  emoji: string | null;\n  /**\n   * If set, the status will not be shown after this date.\n   */\n  expiresAt: string | null;\n  /**\n   * Whether this status indicates the user is not fully available on GitHub.\n   */\n  limitedAvailability: boolean;\n  /**\n   * A brief message describing what the user is doing.\n   */\n  message: string | null;\n}\n```\n\n## Licence\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwsmd%2Fgithub-profile-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwsmd%2Fgithub-profile-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwsmd%2Fgithub-profile-status/lists"}