--- title: "Repositories" description: "Repositories, files, releases, accounts, teams and search." canonical_url: "https://forges.link/reference/repositories" --- # Repositories > Repositories, files, releases, accounts, teams and search. For an operation that the forge lacks, see [Unsupported operations](https://forges.link/reference/provider#unsupported-operations). ## `provider.repos` Repositories, and the labels, milestones and collaborators that belong to them. ### `repos.get()` Reads a repository by its ref. Rejects with `NotFoundError` when it does not exist or the credential cannot see it. **Capability:** `repos.get`. ```ts repos.get(ref: RepoRef, options?: RepoGetOptions): Promise ```

Parameter	Type
`ref`	`RepoRef`
`options?`	`RepoGetOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#repo) ### `repos.list()` The authenticated account's repositories, or the installation's under app auth. **Capability:** `repos.list`. Anonymous providers reject it. ```ts repos.list(options?: RepoQuery): ForgeIterable repos.listPage(options?: RepoQuery): Promise> ```

Parameter	Type
`options?`	`RepoQuery`

**Returns:** - `repos.list()`: [`ForgeIterable`](https://forges.link/reference/data-model#repo) - `repos.listPage()`: [`Promise>`](https://forges.link/reference/data-model#repo) ### `repos.byOwner()` The repositories of a user, organisation, group, workspace or project that the credential can see. **Capability:** `repos.byOwner`. ```ts repos.byOwner(owner: RepoRef, query?: OwnerRepoQuery): ForgeIterable repos.byOwnerPage(owner: RepoRef, query?: OwnerRepoQuery): Promise> ```

Parameter	Type	Description
`owner`	`RepoRef`	A namespace ref, such as `{ forge, instance, owner: 'acme', name: '', kind: 'namespace' }` .
`query?`	`OwnerRepoQuery`

**Returns:** - `repos.byOwner()`: [`ForgeIterable`](https://forges.link/reference/data-model#repo) - `repos.byOwnerPage()`: [`Promise>`](https://forges.link/reference/data-model#repo) ### `repos.labels()` Every label defined on the repository, whether or not a thread carries it. **Capability:** `repos.labels`. ```ts repos.labels(repo: RepoRef, options?: PageOptions): ForgeIterable repos.labelsPage(repo: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`PageOptions`

**Returns:** - `repos.labels()`: [`ForgeIterable`](https://forges.link/reference/data-model#label) - `repos.labelsPage()`: [`Promise>`](https://forges.link/reference/data-model#label) ### `repos.createLabel()` Creates a label in a repository. A repeat rejects on most forges, because the name is taken. **Capability:** `repos.createLabel`. Read-only and anonymous providers reject it. ```ts repos.createLabel(repo: RepoRef, label: LabelInput, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`label`	`LabelInput`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#label) ### `repos.milestones()` Lists the milestones of a repository. **Capability:** `repos.milestones`. ```ts repos.milestones(repo: RepoRef, options?: MilestoneListOptions): ForgeIterable repos.milestonesPage(repo: RepoRef, options?: MilestoneListOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`MilestoneListOptions`

**Returns:** - `repos.milestones()`: [`ForgeIterable`](https://forges.link/reference/data-model#milestone) - `repos.milestonesPage()`: [`Promise>`](https://forges.link/reference/data-model#milestone) ### `repos.collaborators()` Lists the collaborators of a repository, with their roles. **Capability:** `repos.collaborators`. ```ts repos.collaborators(repo: RepoRef, options?: PageOptions): ForgeIterable repos.collaboratorsPage(repo: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`PageOptions`

**Returns:** - `repos.collaborators()`: [`ForgeIterable`](https://forges.link/reference/data-model#collaborator) - `repos.collaboratorsPage()`: [`Promise>`](https://forges.link/reference/data-model#collaborator) ### `repos.contributors()` Lists the commit authors of a repository with their commit counts, most commits first. **Capability:** `repos.contributors`. ```ts repos.contributors(repo: RepoRef, options?: PageOptions): ForgeIterable repos.contributorsPage(repo: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`PageOptions`

**Returns:** - `repos.contributors()`: [`ForgeIterable`](https://forges.link/reference/data-model#contributor) - `repos.contributorsPage()`: [`Promise>`](https://forges.link/reference/data-model#contributor) ### `repos.contributorStats()` Weekly commit activity of each contributor to a repository. Where the forge computes the statistics in the background, the provider waits for them, and throws a `ForgeApiError` with status `202` if they are still not ready. **Capability:** `repos.contributorStats`. ```ts repos.contributorStats(repo: RepoRef, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#contributorstats) ### `repos.templates()` The issue and pull request templates a repository offers, ready to fill in before `threads.create()`. On GitHub, a repository without its own falls back to the owner's `.github` repository, same as the web UI. **Example** ```ts const [template] = await provider.repos.templates(repo, { kind: 'pull_request' }) const body = template?.body ?? '' ``` **Capability:** `repos.templates`. ```ts repos.templates(repo: RepoRef, options?: RepoTemplateOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`RepoTemplateOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#repotemplate) ### `repos.permissionFor()` One account's role on the repository; `'none'` when it has no access. **Capability:** `repos.permissionFor`. ```ts repos.permissionFor(repo: RepoRef, actor: string | Actor, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`actor`	`string \| Actor`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#reporole) ### `repos.addCollaborator()` Gives an account a role on a repository, or invites it where the forge asks the account to accept first. A repeat can reject where the forge refuses to add an existing member (GitLab). **Capability:** `repos.addCollaborator`. Read-only and anonymous providers reject it. ```ts repos.addCollaborator(repo: RepoRef, actor: string | Actor, role: RepoRole, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`actor`	`string \| Actor`
`role`	`RepoRole`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#addcollaboratorresult) ### `repos.assignableUsers()` Accounts that can be assigned to a thread in the repository. **Capability:** `repos.assignableUsers`. ```ts repos.assignableUsers(repo: RepoRef, options?: PageOptions): ForgeIterable repos.assignableUsersPage(repo: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`PageOptions`

**Returns:** - `repos.assignableUsers()`: [`ForgeIterable`](https://forges.link/reference/data-model#actor) - `repos.assignableUsersPage()`: [`Promise>`](https://forges.link/reference/data-model#actor) ### `repos.reviewerCandidates()` Accounts that can be asked to review a given pull request. **Capability:** `repos.reviewerCandidates`. ```ts repos.reviewerCandidates(ref: ThreadRef, options?: PageOptions): ForgeIterable repos.reviewerCandidatesPage(ref: ThreadRef, options?: PageOptions): Promise> ```

Parameter	Type
`ref`	`ThreadRef`
`options?`	`PageOptions`

**Returns:** - `repos.reviewerCandidates()`: [`ForgeIterable`](https://forges.link/reference/data-model#actor) - `repos.reviewerCandidatesPage()`: [`Promise>`](https://forges.link/reference/data-model#actor) ### `repos.events()` Lists the activity feed of a repository: pushes, new branches and tags, and changes to its threads and releases. Events come in the order the forge added them to the feed, latest first, which can differ from `occurredAt` where the forge adds events late. Each event has `source: 'poll'`. **Capability:** `repos.events`. ```ts repos.events(repo: RepoRef, options?: EventFeedOptions): ForgeIterable repos.eventsPage(repo: RepoRef, options?: EventFeedOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`EventFeedOptions`

**Returns:** - `repos.events()`: [`ForgeIterable`](https://forges.link/reference/data-model#forgeevent) - `repos.eventsPage()`: [`Promise>`](https://forges.link/reference/data-model#forgeevent) ## `provider.contents` Files, trees, branches, tags and commits of a repository. ### `contents.file()` One file's contents. Binary-safe: `content` is a `Uint8Array` unless the forge reports text and `as: 'text'` was asked for. Files past the forge's inline limit (1 MB on GitHub) are read from the raw or blob endpoint instead of failing. **Example** ```ts const file = await provider.contents.file(repo, 'package.json', { as: 'text' }) const manifest = JSON.parse(file.content as string) ``` **Capability:** `contents.file`. ```ts contents.file(repo: RepoRef, path: string, options?: FileOptions): Promise ```

Parameter	Type	Description
`repo`	`RepoRef`	The repository to read from.
`path`	`string`	The path of the file from the repository root.
`options?`	`FileOptions`	The revision to read, and whether to decode the content as text.

**Returns:** [`Promise`](https://forges.link/reference/data-model#filecontent) ### `contents.tree()` One level, or every descendant with `recursive`. Truncated listings carry a `tree_truncated` warning. **Capability:** `contents.tree`. ```ts contents.tree(repo: RepoRef, options?: TreeOptions): ForgeIterable contents.treePage(repo: RepoRef, options?: TreeOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`TreeOptions`

**Returns:** - `contents.tree()`: [`ForgeIterable`](https://forges.link/reference/data-model#treeentry) - `contents.treePage()`: [`Promise>`](https://forges.link/reference/data-model#treeentry) ### `contents.branches()` Lists the branches of a repository. **Capability:** `contents.branches`. ```ts contents.branches(repo: RepoRef, options?: PageOptions): ForgeIterable contents.branchesPage(repo: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`PageOptions`

**Returns:** - `contents.branches()`: [`ForgeIterable`](https://forges.link/reference/data-model#branch) - `contents.branchesPage()`: [`Promise>`](https://forges.link/reference/data-model#branch) ### `contents.tags()` Lists the tags of a repository. **Capability:** `contents.tags`. ```ts contents.tags(repo: RepoRef, options?: PageOptions): ForgeIterable contents.tagsPage(repo: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`PageOptions`

**Returns:** - `contents.tags()`: [`ForgeIterable`](https://forges.link/reference/data-model#tag) - `contents.tagsPage()`: [`Promise>`](https://forges.link/reference/data-model#tag) ### `contents.resolveRef()` Resolves a branch, tag or sha to a full commit sha; a full sha is returned as is. **Capability:** `contents.resolveRef`. ```ts contents.resolveRef(repo: RepoRef, ref: string, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`ref`	`string`
`options?`	`BaseOptions`

**Returns:** `Promise` ### `contents.commits()` Lists the commits that lead to `ref`, or to the default branch. **Capability:** `contents.commits`. ```ts contents.commits(repo: RepoRef, query?: CommitQuery): ForgeIterable contents.commitsPage(repo: RepoRef, query?: CommitQuery): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`query?`	`CommitQuery`

**Returns:** - `contents.commits()`: [`ForgeIterable`](https://forges.link/reference/data-model#commit) - `contents.commitsPage()`: [`Promise>`](https://forges.link/reference/data-model#commit) ### `contents.commit()` One commit, with its files and stats. **Capability:** `contents.commit`. ```ts contents.commit(repo: RepoRef, sha: string, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`sha`	`string`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#commit) ### `contents.compare()` Commits and files between two refs. **Capability:** `contents.compare`. ```ts contents.compare(repo: RepoRef, base: string, head: string, options?: CompareOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`base`	`string`
`head`	`string`
`options?`	`CompareOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#comparison) ### `contents.commitFiles()` Writes and deletes files in one commit on a branch, and moves the branch to it. A repeat with `expectedHead` or `createFrom` rejects once the first attempt has moved or created the branch; without them, it adds a second commit. **Example** ```ts const commit = await provider.contents.commitFiles(repo, { branch: 'docs/readme', createFrom: 'main', message: 'docs: update readme', changes: [ { path: 'README.md', content: '# widgets\n' }, { path: 'OLD.md', content: null }, ], }) ``` **Capability:** `contents.commitFiles`. Read-only and anonymous providers reject it. ```ts contents.commitFiles(repo: RepoRef, input: CommitFilesInput, options?: BaseOptions): Promise ```

Parameter	Type	Description
`repo`	`RepoRef`	The repository to commit to.
`input`	`CommitFilesInput`	The branch, the message and the files, with the head the branch must have and the ref to create it from.
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#commit) **Throws:** - `BranchMovedError` when the branch no longer points at `expectedHead`. - `NotFoundError` when a file to delete does not exist. ## `provider.releases` Reading, creating and updating the releases of a repository, and downloading their assets. ### `releases.list()` Lists the releases of a repository, including drafts and pre-releases where the credential can see them. **Capability:** `releases.list`. ```ts releases.list(repo: RepoRef, options?: PageOptions): ForgeIterable releases.listPage(repo: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`PageOptions`

**Returns:** - `releases.list()`: [`ForgeIterable`](https://forges.link/reference/data-model#release) - `releases.listPage()`: [`Promise>`](https://forges.link/reference/data-model#release) ### `releases.get()` Reads a release by its ref. **Capability:** `releases.get`. ```ts releases.get(ref: ReleaseRef, options?: BaseOptions): Promise ```

Parameter	Type
`ref`	`ReleaseRef`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#release) ### `releases.getByTag()` The release for a tag name. **Capability:** `releases.getByTag`. ```ts releases.getByTag(repo: RepoRef, tag: string, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`tag`	`string`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#release) ### `releases.downloadAsset()` Downloads a release asset, as a stream of its bytes, a `Uint8Array` with `as: 'binary'` or a string with `as: 'text'`. A redirect to a CDN host is followed without the `Authorization` header, which those hosts reject. **Example** ```ts const release = await provider.releases.getByTag(repo, 'v1.0.0') const asset = release.assets?.find(asset => asset.name.endsWith('.pdf')) if (asset?.ref) { const bytes = await provider.releases.downloadAsset(asset.ref, { as: 'binary' }) } ``` **Capability:** `releases.downloadAsset`. **Overload 1 of 3** ```ts releases.downloadAsset(ref: ReleaseAssetRef, options?: DownloadAssetOptions & { as?: 'stream' }): Promise> ```

Parameter	Type
`ref`	`ReleaseAssetRef`
`options?`	`DownloadAssetOptions & { as?: 'stream' }`

**Returns:** `Promise>` **Overload 2 of 3** ```ts releases.downloadAsset(ref: ReleaseAssetRef, options: DownloadAssetOptions & { as: 'binary' }): Promise ```

Parameter	Type
`ref`	`ReleaseAssetRef`
`options`	`DownloadAssetOptions & { as: 'binary' }`

**Returns:** `Promise` **Overload 3 of 3** ```ts releases.downloadAsset(ref: ReleaseAssetRef, options: DownloadAssetOptions & { as: 'text' }): Promise ```

Parameter	Type
`ref`	`ReleaseAssetRef`
`options`	`DownloadAssetOptions & { as: 'text' }`

**Returns:** `Promise` ### `releases.latest()` The most recent published release that is not a draft or prerelease, if any. **Capability:** `releases.latest`. ```ts releases.latest(repo: RepoRef, options?: BaseOptions): Promise ```

Parameter	Type
`repo`	`RepoRef`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#release) ### `releases.create()` Creates a release, and its tag from `target` when the tag does not exist yet. A repeat for the same tag rejects on forges that hold one release per tag; read it back with `getByTag()`. **Example** ```ts const release = await provider.releases.create(repo, { tag: 'v1.2.0', body: notes, draft: true }) ``` **Capability:** `releases.create`. Read-only and anonymous providers reject it. ```ts releases.create(repo: RepoRef, input: ReleaseInput, options?: BaseOptions): Promise ```

Parameter	Type	Description
`repo`	`RepoRef`	The repository to release.
`input`	`ReleaseInput`	The tag, the name, the notes and whether the release is a draft or a prerelease.
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#release) **Throws:** - `UnsupportedOperationError` for `draft: true` or `prerelease: true` on a forge without drafts or prereleases. ### `releases.update()` Changes a release. Fields left out stay as they are, so `{ draft: false }` publishes a draft. **Capability:** `releases.update`. Read-only and anonymous providers reject it. ```ts releases.update(ref: ReleaseRef, update: ReleaseUpdate, options?: BaseOptions): Promise ```

Parameter	Type
`ref`	`ReleaseRef`
`update`	`ReleaseUpdate`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#release) **Throws:** - `UnsupportedOperationError` for a change the forge cannot make, such as a new tag on GitLab. - `ForbiddenError` with reason `immutable_release` when the forge refuses the write because the release is immutable (GitHub); its name, notes, prerelease and `latest` flags stay editable. ## `provider.users` Reading accounts. ### `users.get()` Reads an account by login, without needing a credential where the forge allows it. **Capability:** `users.get`. ```ts users.get(login: string, options?: BaseOptions): Promise ```

Parameter	Type
`login`	`string`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#user) ### `users.me()` The account the provider's credential belongs to. **Example** ```ts const me = await provider.users.me() console.log(me.login) ``` **Capability:** `users.me`. Anonymous providers reject it. ```ts users.me(options?: BaseOptions): Promise ```

Parameter	Type
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#user) ### `users.sponsorable()` Whether an account accepts sponsorship on the forge, such as through a GitHub Sponsors listing. Rejects with `NotFoundError` when no account has the login. **Example** ```ts if (await provider.users.sponsorable('danielroe')) { console.log('https://github.com/sponsors/danielroe') } ``` **Capability:** `users.sponsorable`. Anonymous providers reject it. ```ts users.sponsorable(login: string, options?: BaseOptions): Promise ```

Parameter	Type	Description
`login`	`string`	The account to check.
`options?`	`BaseOptions`

**Returns:** `Promise` ### `users.events()` Lists what an account did across the repositories the credential can see, in the feed's order as for `ReposApi.events`. Each event has `source: 'poll'`. **Capability:** `users.events`. ```ts users.events(login: string, options?: EventFeedOptions): ForgeIterable users.eventsPage(login: string, options?: EventFeedOptions): Promise> ```

Parameter	Type
`login`	`string`
`options?`	`EventFeedOptions`

**Returns:** - `users.events()`: [`ForgeIterable`](https://forges.link/reference/data-model#forgeevent) - `users.eventsPage()`: [`Promise>`](https://forges.link/reference/data-model#forgeevent) ## `provider.installations` The installations of the app that the provider authenticates as. ### `installations.list()` Lists the installations of the app. **Capability:** `installations`. Anonymous providers reject it. ```ts installations.list(options?: PageOptions): ForgeIterable installations.listPage(options?: PageOptions): Promise> ```

Parameter	Type
`options?`	`PageOptions`

**Returns:** - `installations.list()`: [`ForgeIterable`](https://forges.link/reference/data-model#installation) - `installations.listPage()`: [`Promise>`](https://forges.link/reference/data-model#installation) ### `installations.get()` Reads one installation. **Capability:** `installations`. Anonymous providers reject it. ```ts installations.get(installation: Installation | string, options?: BaseOptions): Promise ```

Parameter	Type
`installation`	`Installation \| string`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#installation) ### `installations.token()` Mints (or reuses a cached) installation token. **Capability:** `installations`. Anonymous providers reject it. ```ts installations.token(installation: Installation | string, options?: BaseOptions): Promise ```

Parameter	Type
`installation`	`Installation \| string`
`options?`	`BaseOptions`

**Returns:** [`Promise`](https://forges.link/reference/data-model#installationtoken) ### `installations.repos()` Lists the repositories that an installation can access. **Capability:** `installations`. Anonymous providers reject it. ```ts installations.repos(installation: Installation | string, options?: PageOptions): ForgeIterable installations.reposPage(installation: Installation | string, options?: PageOptions): Promise> ```

Parameter	Type
`installation`	`Installation \| string`
`options?`	`PageOptions`

**Returns:** - `installations.repos()`: [`ForgeIterable`](https://forges.link/reference/data-model#repo) - `installations.reposPage()`: [`Promise>`](https://forges.link/reference/data-model#repo) ### `installations.provider()` Provider authenticated as one installation, sharing this instance's app credentials. **Capability:** `installations`. Anonymous providers reject it. ```ts installations.provider(installation: Installation | string): ForgeProvider ```

Parameter	Type
`installation`	`Installation \| string`

**Returns:** [`ForgeProvider`](https://forges.link/reference/provider) ### `installations.providers()` One provider per installation. **Capability:** `installations`. Anonymous providers reject it. ```ts installations.providers(): AsyncIterable<{ installation: Installation, provider: ForgeProvider }> ``` **Returns:** `AsyncIterable<{ installation: Installation, provider: ForgeProvider }>` ## `provider.orgs` The teams of an organisation and their members. An organisation is a namespace ref, as `repos.byOwner()` takes one. GitLab has no teams of its own, so its subgroups play the role of teams and their members are the subgroup's members. ### `orgs.teams()` Lists the teams of an organisation. **Capability:** `orgs.teams`. ```ts orgs.teams(org: RepoRef, options?: PageOptions): ForgeIterable orgs.teamsPage(org: RepoRef, options?: PageOptions): Promise> ```

Parameter	Type	Description
`org`	`RepoRef`	A namespace ref, such as `{ forge, instance, owner: 'acme', name: '', kind: 'namespace' }` .
`options?`	`PageOptions`

**Returns:** - `orgs.teams()`: [`ForgeIterable`](https://forges.link/reference/data-model#team) - `orgs.teamsPage()`: [`Promise>`](https://forges.link/reference/data-model#team) ### `orgs.teamMembers()` Lists the members of a team, as actors. **Capability:** `orgs.teamMembers`. Anonymous providers reject it. ```ts orgs.teamMembers(team: TeamRef, options?: PageOptions): ForgeIterable orgs.teamMembersPage(team: TeamRef, options?: PageOptions): Promise> ```

Parameter	Type	Description
`team`	`TeamRef`	A team's `ref` from `teams()` , or a ref with only `org` and `slug` , such as `{ forge, instance, org, slug: 'stewards' }` .
`options?`	`PageOptions`

**Returns:** - `orgs.teamMembers()`: [`ForgeIterable`](https://forges.link/reference/data-model#actor) - `orgs.teamMembersPage()`: [`Promise>`](https://forges.link/reference/data-model#actor) ## `provider.search` Searching issues and pull requests, repositories, commits and code across the forge. ### `search.threads()` Issues and pull requests across repositories. Fields the forge cannot filter on come back as a `filter_unsupported` warning on the page. **Capability:** `search.threads`. ```ts search.threads(query: SearchQuery): ForgeIterable search.threadsPage(query: SearchQuery): Promise> ```

Parameter	Type
`query`	`SearchQuery`

**Returns:** - `search.threads()`: [`ForgeIterable`](https://forges.link/reference/data-model#thread) - `search.threadsPage()`: [`Promise>`](https://forges.link/reference/data-model#thread) ### `search.repos()` Searches repositories. **Capability:** `search.repos`. ```ts search.repos(query: RepoSearchQuery): ForgeIterable search.reposPage(query: RepoSearchQuery): Promise> ```

Parameter	Type
`query`	`RepoSearchQuery`

**Returns:** - `search.repos()`: [`ForgeIterable`](https://forges.link/reference/data-model#repo) - `search.reposPage()`: [`Promise>`](https://forges.link/reference/data-model#repo) ### `search.commits()` Commits across repositories, where the forge indexes them. **Capability:** `search.commits`. ```ts search.commits(query: CommitSearchQuery): ForgeIterable search.commitsPage(query: CommitSearchQuery): Promise> ```

Parameter	Type
`query`	`CommitSearchQuery`

**Returns:** - `search.commits()`: [`ForgeIterable`](https://forges.link/reference/data-model#commit) - `search.commitsPage()`: [`Promise>`](https://forges.link/reference/data-model#commit) ### `search.code()` Searches the contents of files, where the forge indexes them. **Capability:** `search.code`. ```ts search.code(query: CodeSearchQuery): ForgeIterable search.codePage(query: CodeSearchQuery): Promise> ```

Parameter	Type
`query`	`CodeSearchQuery`

**Returns:** - `search.code()`: [`ForgeIterable`](https://forges.link/reference/data-model#codematch) - `search.codePage()`: [`Promise>`](https://forges.link/reference/data-model#codematch) ## Sitemap See the full [sitemap](https://forges.link/sitemap.md) for all pages.