Skip to content

Commit 2009cb4

Browse files
Release: v0.8.7 (#131)
## What's Changed * Allow specifying an encoding output in `fromBase64` by @sethvargo in #130 **Full Changelog**: v0.8.6...v0.8.7 --------- Co-authored-by: Seth Vargo <seth@sethvargo.com>
1 parent a1193f1 commit 2009cb4

File tree

29 files changed

+180
-62
lines changed

29 files changed

+180
-62
lines changed

dist/encoding.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ export declare function toBase64(input: string | Buffer): string;
1515
*
1616
* @return Decoded string.
1717
*/
18-
export declare function fromBase64(input: string): string;
18+
export declare function fromBase64(input: string, outEncoding?: BufferEncoding): string;

dist/index.js

Lines changed: 24 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/auth/type-aliases/Credential.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Type Alias: Credential
88

9-
> **Credential**: [`ServiceAccountKey`](ServiceAccountKey.md) \| [`ExternalAccount`](ExternalAccount.md)
9+
> **Credential** = [`ServiceAccountKey`](ServiceAccountKey.md) \| [`ExternalAccount`](ExternalAccount.md)
1010
1111
Defined in: [auth.ts:23](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L23)
1212

docs/auth/type-aliases/ExternalAccount.md

Lines changed: 53 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,95 +6,137 @@
66

77
# Type Alias: ExternalAccount
88

9-
> **ExternalAccount**: `object`
9+
> **ExternalAccount** = `object`
1010
1111
Defined in: [auth.ts:45](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L45)
1212

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

16-
## Type declaration
16+
## Properties
1717

1818
### audience
1919

2020
> **audience**: `string`
2121
22+
Defined in: [auth.ts:47](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L47)
23+
24+
***
25+
2226
### client\_id?
2327

2428
> `optional` **client\_id**: `string`
2529
30+
Defined in: [auth.ts:52](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L52)
31+
32+
***
33+
2634
### client\_secret?
2735

2836
> `optional` **client\_secret**: `string`
2937
38+
Defined in: [auth.ts:53](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L53)
39+
40+
***
41+
3042
### credential\_source
3143

3244
> **credential\_source**: `object`
3345
34-
#### credential\_source.environment\_id?
46+
Defined in: [auth.ts:57](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L57)
47+
48+
#### environment\_id?
3549

3650
> `optional` **environment\_id**: `string`
3751
38-
#### credential\_source.file?
52+
#### file?
3953

4054
> `optional` **file**: `string`
4155
42-
#### credential\_source.format?
56+
#### format?
4357

4458
> `optional` **format**: `object`
4559
46-
#### credential\_source.format.subject\_token\_field\_name?
60+
##### format.subject\_token\_field\_name?
4761

4862
> `optional` **subject\_token\_field\_name**: `string`
4963
50-
#### credential\_source.format.type
64+
##### format.type
5165

5266
> **type**: `"json"` \| `"text"`
5367
54-
#### credential\_source.headers?
68+
#### headers?
5569

5670
> `optional` **headers**: `object`
5771
5872
##### Index Signature
5973

6074
\[`key`: `string`\]: `string`
6175

62-
#### credential\_source.region\_url?
76+
#### region\_url?
6377

6478
> `optional` **region\_url**: `string`
6579
66-
#### credential\_source.regional\_cred\_verification\_url
80+
#### regional\_cred\_verification\_url
6781

6882
> **regional\_cred\_verification\_url**: `string`
6983
70-
#### credential\_source.url?
84+
#### url?
7185

7286
> `optional` **url**: `string`
7387
88+
***
89+
7490
### quota\_project\_id?
7591

7692
> `optional` **quota\_project\_id**: `string`
7793
94+
Defined in: [auth.ts:54](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L54)
95+
96+
***
97+
7898
### service\_account\_impersonation\_url?
7999

80100
> `optional` **service\_account\_impersonation\_url**: `string`
81101
102+
Defined in: [auth.ts:49](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L49)
103+
104+
***
105+
82106
### subject\_token\_type
83107

84108
> **subject\_token\_type**: `string`
85109
110+
Defined in: [auth.ts:48](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L48)
111+
112+
***
113+
86114
### token\_info\_url?
87115

88116
> `optional` **token\_info\_url**: `string`
89117
118+
Defined in: [auth.ts:51](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L51)
119+
120+
***
121+
90122
### token\_url
91123

92124
> **token\_url**: `string`
93125
126+
Defined in: [auth.ts:50](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L50)
127+
128+
***
129+
94130
### type
95131

96132
> **type**: `string`
97133
134+
Defined in: [auth.ts:46](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L46)
135+
136+
***
137+
98138
### workforce\_pool\_user\_project?
99139

100140
> `optional` **workforce\_pool\_user\_project**: `string`
141+
142+
Defined in: [auth.ts:55](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L55)

docs/auth/type-aliases/ServiceAccountKey.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,88 @@
66

77
# Type Alias: ServiceAccountKey
88

9-
> **ServiceAccountKey**: `object`
9+
> **ServiceAccountKey** = `object`
1010
1111
Defined in: [auth.ts:28](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L28)
1212

1313
ServiceAccountKeyCredential is an exported credential for a service account key.
1414

15-
## Type declaration
15+
## Properties
1616

1717
### auth\_provider\_x509\_cert\_url
1818

1919
> **auth\_provider\_x509\_cert\_url**: `string`
2020
21+
Defined in: [auth.ts:37](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L37)
22+
23+
***
24+
2125
### auth\_uri
2226

2327
> **auth\_uri**: `string`
2428
29+
Defined in: [auth.ts:35](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L35)
30+
31+
***
32+
2533
### client\_email
2634

2735
> **client\_email**: `string`
2836
37+
Defined in: [auth.ts:33](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L33)
38+
39+
***
40+
2941
### client\_id
3042

3143
> **client\_id**: `string`
3244
45+
Defined in: [auth.ts:34](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L34)
46+
47+
***
48+
3349
### client\_x509\_cert\_url
3450

3551
> **client\_x509\_cert\_url**: `string`
3652
53+
Defined in: [auth.ts:38](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L38)
54+
55+
***
56+
3757
### private\_key
3858

3959
> **private\_key**: `string`
4060
61+
Defined in: [auth.ts:32](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L32)
62+
63+
***
64+
4165
### private\_key\_id
4266

4367
> **private\_key\_id**: `string`
4468
69+
Defined in: [auth.ts:31](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L31)
70+
71+
***
72+
4573
### project\_id
4674

4775
> **project\_id**: `string`
4876
77+
Defined in: [auth.ts:30](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L30)
78+
79+
***
80+
4981
### token\_uri
5082

5183
> **token\_uri**: `string`
5284
85+
Defined in: [auth.ts:36](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L36)
86+
87+
***
88+
5389
### type
5490

5591
> **type**: `string`
92+
93+
Defined in: [auth.ts:29](https://github.com/google-github-actions/actions-utils/blob/main/src/auth.ts#L29)

docs/clone/functions/deepClone.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ deserialize the input.
1616

1717
## Type Parameters
1818

19-
**T**
19+
### T
20+
21+
`T`
2022

2123
## Parameters
2224

docs/encoding/functions/fromBase64.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Function: fromBase64()
88

9-
> **fromBase64**(`input`): `string`
9+
> **fromBase64**(`input`, `outEncoding?`): `string`
1010
1111
Defined in: [encoding.ts:41](https://github.com/google-github-actions/actions-utils/blob/main/src/encoding.ts#L41)
1212

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

2323
Base64-encoded string.
2424

25+
### outEncoding?
26+
27+
`BufferEncoding`
28+
2529
## Returns
2630

2731
`string`

docs/encoding/functions/toBase64.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ toBase64 base64 encodes the input as URL-encoded, unpadded.
1818

1919
String or Buffer to encode as base64.
2020

21-
`string` | `Buffer`
21+
`string` | `Buffer`\<`ArrayBufferLike`\>
2222

2323
## Returns
2424

docs/enum/functions/toEnum.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ exists, it throws an error.
1515

1616
## Type Parameters
1717

18-
**E** *extends* `Record`\<`string`, `string`\>
18+
### E
19+
20+
`E` *extends* `Record`\<`string`, `string`\>
1921

2022
## Parameters
2123

0 commit comments

Comments
 (0)