Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dist/encoding.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ export declare function toBase64(input: string | Buffer): string;
*
* @return Decoded string.
*/
export declare function fromBase64(input: string): string;
export declare function fromBase64(input: string, outEncoding?: BufferEncoding): string;
30 changes: 24 additions & 6 deletions dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/auth/type-aliases/Credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Type Alias: Credential

> **Credential**: [`ServiceAccountKey`](ServiceAccountKey.md) \| [`ExternalAccount`](ExternalAccount.md)
> **Credential** = [`ServiceAccountKey`](ServiceAccountKey.md) \| [`ExternalAccount`](ExternalAccount.md)

Defined in: [auth.ts:23](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L23)

Expand Down
64 changes: 53 additions & 11 deletions docs/auth/type-aliases/ExternalAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,95 +6,137 @@

# Type Alias: ExternalAccount

> **ExternalAccount**: `object`
> **ExternalAccount** = `object`

Defined in: [auth.ts:45](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L45)

ExternalAccount is an exported credential for an external account
like a workload identity pool.

## Type declaration
## Properties

### audience

> **audience**: `string`

Defined in: [auth.ts:47](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L47)

***

### client\_id?

> `optional` **client\_id**: `string`

Defined in: [auth.ts:52](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L52)

***

### client\_secret?

> `optional` **client\_secret**: `string`

Defined in: [auth.ts:53](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L53)

***

### credential\_source

> **credential\_source**: `object`

#### credential\_source.environment\_id?
Defined in: [auth.ts:57](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L57)

#### environment\_id?

> `optional` **environment\_id**: `string`

#### credential\_source.file?
#### file?

> `optional` **file**: `string`

#### credential\_source.format?
#### format?

> `optional` **format**: `object`

#### credential\_source.format.subject\_token\_field\_name?
##### format.subject\_token\_field\_name?

> `optional` **subject\_token\_field\_name**: `string`

#### credential\_source.format.type
##### format.type

> **type**: `"json"` \| `"text"`

#### credential\_source.headers?
#### headers?

> `optional` **headers**: `object`

##### Index Signature

\[`key`: `string`\]: `string`

#### credential\_source.region\_url?
#### region\_url?

> `optional` **region\_url**: `string`

#### credential\_source.regional\_cred\_verification\_url
#### regional\_cred\_verification\_url

> **regional\_cred\_verification\_url**: `string`

#### credential\_source.url?
#### url?

> `optional` **url**: `string`

***

### quota\_project\_id?

> `optional` **quota\_project\_id**: `string`

Defined in: [auth.ts:54](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L54)

***

### service\_account\_impersonation\_url?

> `optional` **service\_account\_impersonation\_url**: `string`

Defined in: [auth.ts:49](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L49)

***

### subject\_token\_type

> **subject\_token\_type**: `string`

Defined in: [auth.ts:48](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L48)

***

### token\_info\_url?

> `optional` **token\_info\_url**: `string`

Defined in: [auth.ts:51](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L51)

***

### token\_url

> **token\_url**: `string`

Defined in: [auth.ts:50](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L50)

***

### type

> **type**: `string`

Defined in: [auth.ts:46](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L46)

***

### workforce\_pool\_user\_project?

> `optional` **workforce\_pool\_user\_project**: `string`

Defined in: [auth.ts:55](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L55)
42 changes: 40 additions & 2 deletions docs/auth/type-aliases/ServiceAccountKey.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,50 +6,88 @@

# Type Alias: ServiceAccountKey

> **ServiceAccountKey**: `object`
> **ServiceAccountKey** = `object`

Defined in: [auth.ts:28](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L28)

ServiceAccountKeyCredential is an exported credential for a service account key.

## Type declaration
## Properties

### auth\_provider\_x509\_cert\_url

> **auth\_provider\_x509\_cert\_url**: `string`

Defined in: [auth.ts:37](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L37)

***

### auth\_uri

> **auth\_uri**: `string`

Defined in: [auth.ts:35](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L35)

***

### client\_email

> **client\_email**: `string`

Defined in: [auth.ts:33](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L33)

***

### client\_id

> **client\_id**: `string`

Defined in: [auth.ts:34](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L34)

***

### client\_x509\_cert\_url

> **client\_x509\_cert\_url**: `string`

Defined in: [auth.ts:38](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L38)

***

### private\_key

> **private\_key**: `string`

Defined in: [auth.ts:32](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L32)

***

### private\_key\_id

> **private\_key\_id**: `string`

Defined in: [auth.ts:31](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L31)

***

### project\_id

> **project\_id**: `string`

Defined in: [auth.ts:30](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L30)

***

### token\_uri

> **token\_uri**: `string`

Defined in: [auth.ts:36](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L36)

***

### type

> **type**: `string`

Defined in: [auth.ts:29](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L29)
4 changes: 3 additions & 1 deletion docs/clone/functions/deepClone.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ deserialize the input.

## Type Parameters

• **T**
### T

`T`

## Parameters

Expand Down
6 changes: 5 additions & 1 deletion docs/encoding/functions/fromBase64.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Function: fromBase64()

> **fromBase64**(`input`): `string`
> **fromBase64**(`input`, `outEncoding?`): `string`

Defined in: [encoding.ts:41](https://github.com/google-github-actions/actions-utils/blob/main/src/encoding.ts#L41)

Expand All @@ -22,6 +22,10 @@ return result is a string and therefore this will not work with binary data.

Base64-encoded string.

### outEncoding?

`BufferEncoding`

## Returns

`string`
Expand Down
2 changes: 1 addition & 1 deletion docs/encoding/functions/toBase64.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ toBase64 base64 encodes the input as URL-encoded, unpadded.

String or Buffer to encode as base64.

`string` | `Buffer`
`string` | `Buffer`\<`ArrayBufferLike`\>

## Returns

Expand Down
4 changes: 3 additions & 1 deletion docs/enum/functions/toEnum.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ exists, it throws an error.

## Type Parameters

• **E** *extends* `Record`\<`string`, `string`\>
### E

`E` *extends* `Record`\<`string`, `string`\>

## Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs/env/functions/stubEnv.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ Target map to set and restore (defaults to `process.env`).

## Returns

`Function`

Function that restores the environment.

> (): `void`

### Returns

`void`
2 changes: 1 addition & 1 deletion docs/env/type-aliases/ProcessEnv.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Type Alias: ProcessEnv

> **ProcessEnv**: `Record`\<`string`, `string` \| `undefined`\>
> **ProcessEnv** = `Record`\<`string`, `string` \| `undefined`\>

Defined in: [env.ts:20](https://github.com/google-github-actions/actions-utils/blob/main/src/env.ts#L20)

Expand Down
Loading