3.1.216 • Published 8 months ago

@tryvital/vital-node v3.1.216

Weekly downloads
-
License
-
Repository
github
Last release
8 months ago

Vital Node Library

npm shield fern shield

The Vital Node.js library provides access to the Vital API from JavaScript/TypeScript.

Documentation

API reference documentation is available here.

Installation

npm install --save @tryvital/vital-node
# or
yarn add @tryvital/vital-node

Usage

import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';

const vital = new VitalClient({
    apiKey: 'YOUR_API_KEY',
});

const labTest = await vital.labTests.get('order-id');

console.log('Received lab test', labTest);

Handling Errors

When the API returns a non-success status code (4xx or 5xx response), a subclass of VitalError will be thrown:

try {
  await vital.labTests.get('order-id');
} catch (err) {
  if (err instanceof VitalError) {
    console.log(err.statusCode);
    console.log(err.message);
    console.log(err.body);
  }
}

Environments

When you sign up to Vital you get access to two environments, Sandbox and Production.

Environment URLs
productionapi.tryvital.io
production-euapi.eu.tryvital.io
sandboxapi.sandbox.tryvital.io
sandbox-euapi.sandbox.eu.tryvital.io

By default, the SDK uses the production environment. See the snippet below for an example on how ot change the environment.

import { VitalClient, VitalEnvironment } from '@tryvital/vital-node';

const vital = new VitalClient({
    apiKey: 'YOUR_API_KEY',
    environmment: VitalEnvironment.Sandbox,
});

Request Options

Each method in the SDK accepts an additional optional parameter where you can specify request options such as a timeout.

const labTest = await vital.labTests.get('order-id', {
    timeoutInSeconds: 40 // wait 40 seconds for this call
});

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

3.1.216

8 months ago

3.1.215

8 months ago

3.1.214

8 months ago

3.1.213

8 months ago

3.1.205

8 months ago

3.1.204

8 months ago

3.1.203

8 months ago

3.1.212

8 months ago

3.1.211

8 months ago

3.1.210

8 months ago

3.1.209

8 months ago

3.1.208

8 months ago

3.1.207

8 months ago

3.1.206

8 months ago

3.1.201

8 months ago

3.1.200

8 months ago

3.1.202

8 months ago

3.1.199

8 months ago

3.1.198

8 months ago

3.1.197

8 months ago

3.1.196

8 months ago

3.1.195

8 months ago

3.1.194

8 months ago

3.1.193

8 months ago

3.1.192

8 months ago

3.1.191

8 months ago

3.1.190

8 months ago

3.1.189

8 months ago

3.1.179

9 months ago

3.1.178

9 months ago

3.1.188

9 months ago

3.1.187

9 months ago

3.1.182

9 months ago

3.1.181

9 months ago

3.1.180

9 months ago

3.1.186

9 months ago

3.1.185

9 months ago

3.1.184

9 months ago

3.1.183

9 months ago

3.1.177

9 months ago

3.1.176

9 months ago

3.1.171

9 months ago

3.1.175

9 months ago

3.1.174

9 months ago

3.1.173

9 months ago

3.1.172

9 months ago

3.1.170

9 months ago

3.1.152

10 months ago

3.1.151

10 months ago

3.1.150

10 months ago

3.1.149

10 months ago

3.1.148

10 months ago

3.1.139

10 months ago

3.1.146

10 months ago

3.1.145

10 months ago

3.1.144

10 months ago

3.1.143

10 months ago

3.1.147

10 months ago

3.1.142

10 months ago

3.1.141

10 months ago

3.1.140

10 months ago

3.1.138

11 months ago

3.1.137

11 months ago

3.1.135

11 months ago

3.1.134

11 months ago

3.1.133

11 months ago

3.1.136

11 months ago

3.1.132

11 months ago

3.1.131

11 months ago

3.1.130

11 months ago

3.1.129

11 months ago

3.1.124

11 months ago

3.1.128

11 months ago

3.1.127

11 months ago

3.1.126

11 months ago

3.1.125

11 months ago

3.1.117

11 months ago

3.1.116

11 months ago

3.1.115

11 months ago

3.1.114

11 months ago

3.1.123

11 months ago

3.1.122

11 months ago

3.1.121

11 months ago

3.1.120

11 months ago

3.1.119

11 months ago

3.1.118

11 months ago

3.1.113

11 months ago

3.1.112

11 months ago

3.1.111

11 months ago

3.1.110

11 months ago

3.1.109

11 months ago

3.1.108

11 months ago

3.1.107

11 months ago

3.1.106

11 months ago

3.1.102

12 months ago

3.1.101

12 months ago

3.1.100

12 months ago

3.1.105

12 months ago

3.1.104

12 months ago

3.1.103

12 months ago

3.1.99

12 months ago

3.1.94

12 months ago

3.1.96

12 months ago

3.1.95

12 months ago

3.1.98

12 months ago

3.1.97

12 months ago

3.1.92

12 months ago

3.1.91

12 months ago

3.1.93

12 months ago

3.1.90

12 months ago

3.1.89

12 months ago

3.1.88

12 months ago

3.1.87

12 months ago

3.1.85

1 year ago

3.1.86

1 year ago

3.1.84

1 year ago

3.1.78

1 year ago

3.1.77

1 year ago

3.1.79

1 year ago

3.1.76

1 year ago

3.1.75

1 year ago

3.1.81

1 year ago

3.1.80

1 year ago

3.1.83

1 year ago

3.1.82

1 year ago

3.1.74

1 year ago

3.1.67

1 year ago

3.1.66

1 year ago

3.1.69

1 year ago

3.1.68

1 year ago

3.1.65

1 year ago

3.1.70

1 year ago

3.1.72

1 year ago

3.1.71

1 year ago

3.1.73

1 year ago

3.1.63

1 year ago

3.1.62

1 year ago

3.1.64

1 year ago

3.1.59

1 year ago

3.1.61

1 year ago

3.1.60

1 year ago

3.1.58

1 year ago

3.1.56

1 year ago

3.1.57

1 year ago

3.1.55

1 year ago

3.1.54

1 year ago

3.1.50

1 year ago

3.1.52

1 year ago

3.1.51

1 year ago

3.1.53

1 year ago

3.1.34

1 year ago

3.1.33

1 year ago

3.1.36

1 year ago

3.1.35

1 year ago

3.1.38

1 year ago

3.1.37

1 year ago

3.1.39

1 year ago

3.1.30

1 year ago

3.1.32

1 year ago

3.1.31

1 year ago

3.1.45

1 year ago

3.1.44

1 year ago

3.1.47

1 year ago

3.1.46

1 year ago

3.1.49

1 year ago

3.1.48

1 year ago

3.1.41

1 year ago

3.1.40

1 year ago

3.1.43

1 year ago

3.1.42

1 year ago

3.1.14

1 year ago

3.1.16

1 year ago

3.1.15

1 year ago

3.1.18

1 year ago

3.1.17

1 year ago

3.1.23

1 year ago

3.1.22

1 year ago

3.1.25

1 year ago

3.1.24

1 year ago

3.1.27

1 year ago

3.1.26

1 year ago

3.1.29

1 year ago

3.1.28

1 year ago

3.1.21

1 year ago

3.1.20

1 year ago

3.1.19

1 year ago

3.1.12

1 year ago

3.1.11

1 year ago

3.1.13

1 year ago

3.1.10

1 year ago

3.1.9

1 year ago

3.1.8

1 year ago

3.1.7

1 year ago

3.1.6

1 year ago

3.1.5

1 year ago

3.1.4

1 year ago

3.1.3

2 years ago

3.1.2

2 years ago

3.1.1

2 years ago

3.1.0

2 years ago

3.0.9

2 years ago

3.0.8

2 years ago

3.0.7

2 years ago

3.0.6

2 years ago

3.0.4

2 years ago

3.0.5

2 years ago

3.0.3

2 years ago

3.0.2

2 years ago

3.0.1

2 years ago

2.1.16

2 years ago

2.1.17

2 years ago

2.1.14

2 years ago

2.1.15

2 years ago

2.1.12

2 years ago

2.1.13

2 years ago

2.1.11

2 years ago

3.0.0-beta.0

2 years ago

2.1.19

2 years ago

2.1.21

2 years ago

2.1.22

2 years ago

2.1.20

2 years ago

2.1.9

2 years ago

2.1.8

2 years ago

2.1.7

2 years ago

2.1.2

3 years ago

2.1.4

3 years ago

2.1.6

3 years ago

2.1.5

3 years ago

1.6.4

3 years ago

1.6.3

3 years ago

1.6.0

3 years ago

2.1.1

3 years ago

2.1.0

3 years ago

1.6.5

3 years ago

1.5.0

3 years ago

1.4.9

3 years ago

1.4.8

3 years ago

1.4.7

3 years ago

1.4.6

3 years ago

1.4.5

3 years ago

1.4.4

3 years ago

1.4.3

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.3.9

3 years ago

1.3.8

3 years ago

1.3.6

3 years ago

1.3.5

4 years ago

1.3.4

4 years ago

1.3.3

4 years ago

1.3.2

4 years ago

1.3.1

4 years ago

1.3.0

4 years ago

1.2.0

4 years ago

1.1.1

4 years ago

1.0.2

4 years ago

1.1.0

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

0.3.9

4 years ago

0.3.6

4 years ago

0.3.5

4 years ago

0.3.8

4 years ago

0.3.7

4 years ago

0.3.2

4 years ago

0.3.1

4 years ago

0.3.4

4 years ago

0.3.3

4 years ago

0.3.0

4 years ago

0.2.9

4 years ago

0.2.8

4 years ago

0.2.7

4 years ago

0.2.6

4 years ago

0.2.5

4 years ago

0.2.4

4 years ago

0.2.3

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.2.2

4 years ago

0.1.3

4 years ago

0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago