compassionatecareservicejsclient
v1.0.0
Published
## Installation 1. Add this package as a dependency in `Config` ``` dependencies = { 1.0 = { ... CompassionateCareServiceJSClient = 1.0; }; }; ``` 1. Add this package as a depende
Downloads
1
Readme
CompassionateCareServiceJSClient - @amzn/compassionate-care-service-jsclient
Installation
Add this package as a dependency in
Config
dependencies = { 1.0 = { ... CompassionateCareServiceJSClient = 1.0; }; };
Add this package as a dependency to the npm package.json
"dependencies": { "@amzn/compassionate-care-service-jsclient": "*", .... }
Create and use clients
const generateDocs = async (): Promise<File[]> => { const ccsClient = new CompassionateCareServiceLambdaClient({ endpoint: getConfig().url }); const generateDocCommand = new GenerateDocumentCommand({ dependentDateOfPassing: new Date().toISOString(), dependentName: "name", employeeId: "156315", employeeRelationship: RelationshipEnumString.CHILD, enrolledBenefits: undefined, requester: "", specialistName: "" }); const response = await ccsClient.send(generateDocCommand); return response.documents!; }
The NPM package name should always start with @amzn/
to cleanly separate from
public packages, avoid accidental publish to public repository, and allow
publishing to CodeArtifact.
The package is built with NpmPrettyMuch and allows using internal (first-party) dependencies as well as external npmjs.com packages.
Add registry dependencies with brazil-build install
exactly the same as npm
install
. You can check
latest state of external dependencies on https://npmpm.corp.amazon.com/
Important: always use brazil-build
wrapper for npm, using npm
directly will
use the public registry instead of the internal registry.
Add brazil packages that build npm packages to the dependencies
or
test-dependencies
sections in the Config file, then add a *
dependency or
devDependencies to package.json. You should match test-dependencies
with
devDependencies
, and normal dependencies
with dependencies
.
NpmPrettyMuch 1.0 has special behavior for running tests during build. The
option "runTest": "never"
disabled this and instead tests are wired up in
prepublishOnly
. NpmPrettyMuch will invoke prepublishOnly
and everything can
configured in there the same as with external
npm. Files to published are configured
using files
in
package.json
.
The option ciBuild
uses npm
ci
instead of npm install
and
results in faster install times and guarantees all of your dependencies are
locked appropriately.