skikrumb-api 1.0.5 → 1.0.6
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/package.json +1 -1
- package/{README.md → readme.md} +25 -3
package/package.json
CHANGED
package/{README.md → readme.md}
RENAMED
|
@@ -21,6 +21,30 @@ const {readDeviceData} = skiKrumb({
|
|
|
21
21
|
url: 'Defaults to http://api.skikrumb.ca'
|
|
22
22
|
})
|
|
23
23
|
```
|
|
24
|
+
### skiKrumb(options?)
|
|
25
|
+
#### options
|
|
26
|
+
|
|
27
|
+
Type: `object`
|
|
28
|
+
|
|
29
|
+
##### apiKey
|
|
30
|
+
|
|
31
|
+
Type: `string`
|
|
32
|
+
|
|
33
|
+
Your API Key as provided by skiKrumb.
|
|
34
|
+
|
|
35
|
+
##### requestedWith
|
|
36
|
+
|
|
37
|
+
Type: `string`\
|
|
38
|
+
Default: `'skiKrumb API Wrapper'`
|
|
39
|
+
|
|
40
|
+
Sets the `requestedWith` header. Helps with identifying your application.
|
|
41
|
+
|
|
42
|
+
##### url
|
|
43
|
+
|
|
44
|
+
Type: `string`\
|
|
45
|
+
Default: `'https://api.skikrumb.ca'`
|
|
46
|
+
|
|
47
|
+
Defaults to production skiKrumb API URL. Possible values: `https://api-dev.skikrumb.ca` or localhost testing.
|
|
24
48
|
|
|
25
49
|
## API Documentation
|
|
26
50
|
#### [Swagger Documentation](https://api.skikrumb.ca/documentation/static/index.html)
|
|
@@ -28,6 +52,4 @@ const {readDeviceData} = skiKrumb({
|
|
|
28
52
|
> Requires an API key. Request an API Key by emailing info@skikrumb.ca
|
|
29
53
|
|
|
30
54
|
> © skiKrumb
|
|
31
|
-
> `2023`
|
|
32
|
-
|
|
33
|
-
|
|
55
|
+
> `2023`
|