Methods
(async) getItemByPath(options)
Get single content item from path relative to project root.
Useful in one-off situations where the path of file is known and constant.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
GetContentByPathOpt |
Returns:
Content item
(async) getItemBySha(options)
Get single content item from SHA value.
Intended to be used in conjunction with `listItems`.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
GetContentByShaOpt |
Returns:
Content item
(async) listItems(options)
Get list of content items from repository via GitHub Trees API.
Will traverse directories recursively to get all items.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
ListFilesOptions | Options for sourcing content from repository. |
Returns:
List of content items with metadata attached.