mirror of
https://github.com/actions/toolkit
synced 2025-05-10 17:12:54 +00:00
Generate Typescript Docs for @actions/artifact
(#1595)
* autogenerate artifact documentation * clean up comments for better autogen docs
This commit is contained in:
parent
43ccaf05d9
commit
64d1b104d0
19 changed files with 1530 additions and 33 deletions
30
packages/artifact/docs/generated/interfaces/FindOptions.md
Normal file
30
packages/artifact/docs/generated/interfaces/FindOptions.md
Normal file
|
@ -0,0 +1,30 @@
|
|||
[@actions/artifact](../README.md) / FindOptions
|
||||
|
||||
# Interface: FindOptions
|
||||
|
||||
## Table of contents
|
||||
|
||||
### Properties
|
||||
|
||||
- [findBy](FindOptions.md#findby)
|
||||
|
||||
## Properties
|
||||
|
||||
### findBy
|
||||
|
||||
• `Optional` **findBy**: `Object`
|
||||
|
||||
The criteria for finding Artifact(s) out of the scope of the current run.
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type | Description |
|
||||
| :------ | :------ | :------ |
|
||||
| `repositoryName` | `string` | Repository owner (eg. 'toolkit') |
|
||||
| `repositoryOwner` | `string` | Repository owner (eg. 'actions') |
|
||||
| `token` | `string` | Token with actions:read permissions |
|
||||
| `workflowRunId` | `number` | WorkflowRun of the artifact(s) to lookup |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/internal/shared/interfaces.ts:131](https://github.com/actions/toolkit/blob/e3764a5/packages/artifact/src/internal/shared/interfaces.ts#L131)
|
Loading…
Add table
Add a link
Reference in a new issue