@aws-lite/sts-types 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +28 -0
- package/package.json +26 -0
- package/readme.md +46 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import {
|
|
2
|
+
/* ! Do not remove IMPORTS_START / IMPORTS_END ! */
|
|
3
|
+
// $IMPORTS_START
|
|
4
|
+
GetCallerIdentityCommandOutput as GetCallerIdentityResponse,
|
|
5
|
+
// $IMPORTS_END
|
|
6
|
+
} from "@aws-sdk/client-sts";
|
|
7
|
+
|
|
8
|
+
declare interface AwsLiteSTS {
|
|
9
|
+
/* ! Do not remove METHODS_START / METHODS_END ! */
|
|
10
|
+
// $METHODS_START
|
|
11
|
+
/** @description aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sts/readme.md#GetCallerIdentity STS: GetCallerIdentity} */
|
|
12
|
+
GetCallerIdentity: () => Promise<GetCallerIdentityResponse>
|
|
13
|
+
// $METHODS_END
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
declare module "@aws-lite/client" {
|
|
17
|
+
interface AwsLiteClient {
|
|
18
|
+
STS: AwsLiteSTS;
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export type {
|
|
23
|
+
AwsLiteSTS,
|
|
24
|
+
/* ! Do not remove EXPORT_START / EXPORT_END ! */
|
|
25
|
+
// $EXPORT_START
|
|
26
|
+
GetCallerIdentityResponse,
|
|
27
|
+
// $EXPORT_END
|
|
28
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@aws-lite/sts-types",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "Type definitions for the `@aws-lite/sts` plugin",
|
|
5
|
+
"homepage": "https://aws-lite.org/services/sts",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/architect/aws-lite.git",
|
|
9
|
+
"directory": "plugins/sts/types"
|
|
10
|
+
},
|
|
11
|
+
"bugs": "https://github.com/architect/aws-lite/issues",
|
|
12
|
+
"main": "",
|
|
13
|
+
"engines": {
|
|
14
|
+
"node": ">=16"
|
|
15
|
+
},
|
|
16
|
+
"author": "@architect",
|
|
17
|
+
"license": "Apache-2.0",
|
|
18
|
+
"types": "index.d.ts",
|
|
19
|
+
"files": [
|
|
20
|
+
"index.d.ts"
|
|
21
|
+
],
|
|
22
|
+
"dependencies": {
|
|
23
|
+
"@aws-sdk/client-sts": "3"
|
|
24
|
+
},
|
|
25
|
+
"scripts": {}
|
|
26
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
## Install
|
|
2
|
+
|
|
3
|
+
Add to `devDependencies` in `package.json`:
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
npm i -D @aws-lite/sts-types
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
<small>Be sure you also have `@aws-lite/sts` installed.</small>
|
|
10
|
+
|
|
11
|
+
## Usage and Config
|
|
12
|
+
|
|
13
|
+
### Javascript VSCode Intellisense
|
|
14
|
+
|
|
15
|
+
In a Javascript project, the ambient types will be automatically loaded.
|
|
16
|
+
|
|
17
|
+
### TypeScript `tsconfig`
|
|
18
|
+
|
|
19
|
+
#### Add this package to `compilerOptions.types`
|
|
20
|
+
|
|
21
|
+
Example:
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"extends": "@tsconfig/node-lts/tsconfig.json",
|
|
26
|
+
"compilerOptions": {
|
|
27
|
+
"types": [
|
|
28
|
+
"@aws-lite/sts-types"
|
|
29
|
+
]
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
#### Or use reference types
|
|
35
|
+
|
|
36
|
+
Either in individual files or in an `index.d.ts` file.
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
/// <reference types="@aws-lite/sts-types" />
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
ymmv
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
/// <reference path="./node_modules/@aws-lite/sts-types/index.d.ts" />
|
|
46
|
+
```
|