github.gettreeprops
Home > @runlightyear/github > GetTreeProps
GetTreeProps interface
Signature:interface GetTreeProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| owner | string | The account owner of the repository. The name is not case sensitive. | |
| repo | string | The name of the repository without the .git extension. The name is not case sensitive. | |
| treeSha | string | The SHA1 value or ref (branch or tag) name of the tree. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| recursive? | string | boolean | number | Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in :tree_sha. For example, setting recursive to any of the following will enable returning objects or subtrees: 0, 1, "true", and "false". Omit this parameter to prevent recursively returning objects or subtrees. |