@barchart/portfolio-client-js 1.3.19 → 1.4.3

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/.jshintrc CHANGED
@@ -1,4 +1,5 @@
1
1
  {
2
2
  "esversion": 6,
3
- "validthis": true
3
+ "validthis": true,
4
+ "-W018": true
4
5
  }
package/README.md CHANGED
@@ -1,24 +1,24 @@
1
1
  # @barchart/portfolio-client-js
2
- ## JavaScript library for interfacing with Barchart's Portfolio API
3
2
 
4
- ## Documentation
3
+ [![AWS CodeBuild](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiM0hCbTN3M253WGFUUUpFcnk1RFZOSTdUcUZnOWJxbXltaEMvQ3JrcENZeWI0cFRDWlFidks2VFhNR3lHeHlBUVdOSjk5TDU5MWd1bE1abGtoc3p1NjFrPSIsIml2UGFyYW1ldGVyU3BlYyI6InZMalFMNG9pZ3E1ekxJSEciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)](https://github.com/barchart/portfolio-client-js)
5
4
 
6
- The code is documented with [JSDoc](http://usejsdoc.org/). While the output hasn't been committed to source control, you can generate the documentation by using the following commands:
5
+ A JavaScript SDK for interfacing with the Barchart Portfolio System.
7
6
 
8
- > npm install
9
- > gulp document
7
+ ### Development
10
8
 
11
- ## Development
9
+ #### Documentation
12
10
 
13
- Gulp is used to check "linting" and to run unit tests.
11
+ The code is documented with [JSDoc](http://usejsdoc.org/). This will be used as the basis for formal documentation (coming soon).
14
12
 
15
- > nvm use 6.11.1
16
- > npm install
17
- > gulp lint
18
- > gulp test
13
+ #### Package Managers
19
14
 
20
- ## Build
15
+ This library has been published as a *private* module to NPM as [@barchart/portfolio-client-js](https://www.npmjs.com/package/@barchart/portfolio-client-js).
21
16
 
22
- Polyfills for ES6 are required:
17
+ ```shell
18
+ npm login
19
+ npm install @barchart/portfolio-client-js -S
20
+ ```
23
21
 
24
- * Promise
22
+ #### Build
23
+
24
+ Modern JavaScript language features are used. Some browsers may still require polyfills.
package/buildspec.yml ADDED
@@ -0,0 +1,15 @@
1
+ version: 0.2
2
+
3
+ phases:
4
+ install:
5
+ runtime-versions:
6
+ nodejs: 12.x
7
+
8
+ pre_build:
9
+ commands:
10
+ - npm install
11
+
12
+ build:
13
+ commands:
14
+ - ./node_modules/.bin/gulp lint
15
+ - ./node_modules/.bin/gulp test