Skip to content

Commit 828045b

Browse files
author
Jonathan Wenger
committed
Updates to readme and package.json
1 parent bd2dbff commit 828045b

File tree

2 files changed

+17
-15
lines changed

2 files changed

+17
-15
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# ava-typescript Rest V2 Node.js SDK
2-
ava-typescript v2 SDK for languages using node.js
1+
# AvaTax Rest V2 Node.js SDK
2+
AvaTax v2 SDK for languages using node.js
33

44
[![Version](https://img.shields.io/npm/v/avatax.svg?style=plastic)](https://www.npmjs.org/package/avatax)
55
[![Build Status](https://api.travis-ci.org/avadev/AvaTax-REST-V2-JRE-SDK.svg?branch=master&style=plastic)](https://travis-ci.org/avadev/AvaTax-REST-V2-JS-SDK)
@@ -10,10 +10,10 @@ ava-typescript v2 SDK for languages using node.js
1010
Install the package with:
1111
``` bash
1212
# using npm
13-
npm install ava-typescript
13+
npm install avatax
1414

1515
# using yarn
16-
yarn add ava-typescript
16+
yarn add avatax
1717
```
1818

1919
## Usage
@@ -22,18 +22,24 @@ yarn add ava-typescript
2222
``` js
2323

2424
// es5 import
25-
var Avatax = require('ava-typescript');
25+
var Avatax = require('avatax');
2626

2727
// es6/7 import
28-
// import Avatax from 'ava-typescript';
28+
// import Avatax from 'avatax';
2929

30-
// resolve configuration and credentials
30+
// resolve configuration, credentials and logOptions
3131
const config = {
3232
appName: 'your-app',
3333
appVersion: '1.0',
3434
environment: 'sandbox',
3535
machineName: 'your-machine-name'
36-
timeout: 5000 // optional, default 20 min
36+
timeout: 5000, // optional, default 20 min
37+
logOptions: {
38+
logEnabled: true, // toggle logging on or off, by default its off.
39+
logLevel: LogLevel.Info, // logLevel that will be used, Options are LogLevel.Error, LogLevel.Warn, LogLevel.Info, LogLevel.Debug
40+
logRequestAndResponseInfo: true, // Toggle logging of the request and response bodies on and off.
41+
logger: myCustomLogger // (OPTIONAL) Custom logger can be passed in that implements the BaseLogger interface (e.g. debug, info, warn, error, and log functions) Otherwise console.log/error etc will be used by default.
42+
}
3743
};
3844

3945
const creds = {
@@ -101,10 +107,7 @@ return client.resolveAddress(address)
101107
```
102108
## Release Notes
103109

104-
In the JS-SDK 21.2.1 release, the SDK can now return big integers from API responses.
105-
Big integers in JavaScript are displayed in responses by appending an 'n' to the end of an integer literal. For example, 618368842515476464 -> 618368842515476464n.
106-
Numbers are presented as before. For example, 8456123 -> 8456123.
107-
For more information, refer to the following Mozilla documentation: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt
110+
Please see the [Github releases](https://github.com/avadev/AvaTax-REST-V2-JS-SDK/releases) for in-depth release notes.
108111

109112
## SDK Development
110113

@@ -139,5 +142,4 @@ https://github.com/avadev/AvaTax-REST-V2-JS-SDK/blob/master/test/helpers/load_cr
139142
``` bash
140143
# assuming a tag of v17.5.2 and a remote of 'upstream'
141144
git push upstream v17.5.2
142-
```
143-
145+
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "ava-typescript",
2+
"name": "avatax",
33
"version": "22.10.0",
44
"description": "AvaTax v2 SDK for languages using JavaScript",
55
"main": "index.js",

0 commit comments

Comments
 (0)