@aws/amazon-location-client 1.0.0 → 1.0.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 +10 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,13 +5,15 @@ Distribution of the [AWS SDK for JavaScript v3](https://github.com/aws/aws-sdk-j
|
|
|
5
5
|
# Installation
|
|
6
6
|
|
|
7
7
|
## Usage with the browser
|
|
8
|
+
|
|
8
9
|
Add the script to an HTML file for usage directly in the browser.
|
|
9
10
|
|
|
10
11
|
```html
|
|
11
|
-
<script src="https://www.unpkg.com/@aws/amazon-location-client
|
|
12
|
+
<script src="https://www.unpkg.com/@aws/amazon-location-client@1.x/dist/amazonLocationClient.js"></script>
|
|
12
13
|
```
|
|
13
14
|
|
|
14
15
|
## Usage with modules
|
|
16
|
+
|
|
15
17
|
We recommend to use [@aws-sdk/client-location](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-location/) and [@aws-sdk/credential-providers](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/) from the [AWS SDK for JavaScript v3](https://github.com/aws/aws-sdk-js-v3) for the full benefit of modularized AWS SDK.
|
|
16
18
|
|
|
17
19
|
# Usage
|
|
@@ -22,7 +24,7 @@ This example uses the Amazon Location Client to make a request that that authent
|
|
|
22
24
|
|
|
23
25
|
```html
|
|
24
26
|
<!-- Importing Amazon Location Client -->
|
|
25
|
-
<script src="https://www.unpkg.com/@aws/amazon-location-client
|
|
27
|
+
<script src="https://www.unpkg.com/@aws/amazon-location-client@1.x/dist/amazonLocationClient.js"></script>
|
|
26
28
|
```
|
|
27
29
|
|
|
28
30
|
```javascript
|
|
@@ -42,14 +44,13 @@ const command = new amazonLocationClient.CalculateRouteCommand(input);
|
|
|
42
44
|
const response = await client.send(command);
|
|
43
45
|
```
|
|
44
46
|
|
|
45
|
-
|
|
46
47
|
We can further simplify the authentication process by introducing the [Amazon Location authentication helper utility library](https://github.com/aws-geospatial/amazon-location-utilities-auth-helper-js)
|
|
47
48
|
|
|
48
49
|
```html
|
|
49
50
|
<!-- Importing Amazon Location Client -->
|
|
50
|
-
<script src="https://www.unpkg.com/@aws/amazon-location-client
|
|
51
|
+
<script src="https://www.unpkg.com/@aws/amazon-location-client@1.x/dist/amazonLocationClient.js"></script>
|
|
51
52
|
<!-- Importing the Amazon Location authentication helper utility library -->
|
|
52
|
-
<script src="https://www.unpkg.com/@aws/amazon-location-utilities-auth-helper
|
|
53
|
+
<script src="https://www.unpkg.com/@aws/amazon-location-utilities-auth-helper@1.x/dist/amazonLocationAuthHelper.js"></script>
|
|
53
54
|
```
|
|
54
55
|
|
|
55
56
|
```javascript
|
|
@@ -68,10 +69,12 @@ const response = await client.send(command);
|
|
|
68
69
|
```
|
|
69
70
|
|
|
70
71
|
# Documentation
|
|
71
|
-
|
|
72
|
+
|
|
73
|
+
Refer to [@aws-sdk/client-location](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-location/) and [@aws-sdk/credential-providers](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-credential-providers/) for documentation.
|
|
72
74
|
|
|
73
75
|
Prefix the class from the @aws-sdk/client-location documentation with `amazonLocationClient.` when using this Amazon Location Client library.
|
|
74
|
-
|
|
76
|
+
|
|
77
|
+
- For example, `const command = new CalculateRouteCommand(input);` should be used as `const command = new amazonLocationClient.CalculateRouteCommand(input);`
|
|
75
78
|
|
|
76
79
|
# Getting Help
|
|
77
80
|
|