@devopness/sdk-js 2.113.0 → 2.113.1
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/README.md +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,8 +62,8 @@ async function getUserProfile() {
|
|
|
62
62
|
await authenticate('user@email.com', 'secret-password');
|
|
63
63
|
|
|
64
64
|
// Now that we're authenticated, we can invoke methods on any services.
|
|
65
|
-
// Here we're invoking the `
|
|
66
|
-
const currentUser = await devopnessApi.users.
|
|
65
|
+
// Here we're invoking the `getUserMe()` method on the `users` service
|
|
66
|
+
const currentUser = await devopnessApi.users.getUserMe();
|
|
67
67
|
console.log('Successfully retrieved user profile: ', currentUser);
|
|
68
68
|
}
|
|
69
69
|
|
|
@@ -74,7 +74,7 @@ getUserProfile();
|
|
|
74
74
|
This package includes TypeScript declarations for every method.
|
|
75
75
|
TypeScript versions `>= 4.4` are supported.
|
|
76
76
|
|
|
77
|
-
>Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you'
|
|
77
|
+
>Some methods in `Devopness SDK JavaScript` accept and return objects from the Devopness API. The type declarations for these objects will always track the latest version of the API. Therefore, if you're using the latest version of this package, you can rely on the Devopness API documentation for checking the input and return types of each API endpoint.
|
|
78
78
|
|
|
79
79
|
## Development & Testing
|
|
80
80
|
To build and test the SDK locally, [**fork this repository**](https://github.com/devopness/devopness/fork) and follow these steps:
|
|
@@ -123,7 +123,7 @@ cd packages/sdks/javascript/
|
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
#### 2. Install missing dependencies
|
|
126
|
-
This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions
|
|
126
|
+
This command will install all modules listed as dependencies in [package.json](package.json). **A working Java Runtime Environment is also required.** Please, check out the installation instructions
|
|
127
127
|
for your operating system.
|
|
128
128
|
```
|
|
129
129
|
npm install
|