4.4.17 • Published 1 year ago

q3-core-responder v4.4.17

Weekly downloads
1,063
License
-
Repository
-
Last release
1 year ago

Responder

Q3 responder handles two responsibilities: (1) assigning HTTP status codes to unhandled exceptions and (2) throwing custom errors in the stack. Within client projects, the first is irrelevant as Q3 registers the functionality via global express middleware. However, the second is very common when dealing with custom validation logic.

API

exception

The exception export offers a chainable API for building general and field-level errors. When constructing, the first parameter will correspond to an HTTP status code (see table below).

ErrorCode
BadRequest400
Authentication401
Authorization403
ResourceNotFound404
Conflict409
Gone410
Preprocessing412
Validation422
InternalServer500

Afterwards, you can chain the following methods. You can invoke msg and field in any order but boomerang, log and throw should end your chain.

MethodParamDescription
msgStringThe language key for a message to decorate the HTTP response
fieldString or ObjectThe field-level error to report. If a string, it will duplicate the msg output. If an object, you can provide custom messages and map to multiple fields.
throwA custom error will throw in your stack
boomerangA custom error will return
logA custom error will log to console

Example

const { exception } = require('q3-core-responder');

function doSomething(args = {}) {
  if (args.bad)
    exception('Conflict')
      .msg('custom18nMessageKey')
      .field('name')
      .throw();

  if (args.reallyBad)
    exception('Validation')
      .msg('custom18nMessageKey')
      .field({
        in: 'application', // can be anything
        name: ['field1', 'field2'],
        msg: 'dataNoGood',
      })
      .throw();
}
4.4.17

1 year ago

4.0.2

1 year ago

3.4.12

2 years ago

3.1.0

2 years ago

2.0.5

2 years ago

2.0.6

2 years ago

2.0.1

2 years ago

1.25.0

2 years ago

1.25.1

2 years ago

1.23.0

2 years ago

1.23.1

2 years ago

1.24.0

2 years ago

1.22.5

3 years ago

1.22.4

3 years ago

1.22.0

3 years ago

1.22.3

3 years ago

1.22.1

3 years ago

1.22.2

3 years ago

1.21.3

3 years ago

1.21.1

3 years ago

1.21.2

3 years ago

1.21.0

3 years ago

1.20.0

3 years ago

1.19.12

3 years ago

1.19.13

3 years ago

1.19.11

3 years ago

1.19.9

3 years ago

1.19.10

3 years ago

1.19.8

3 years ago

1.19.7

3 years ago

1.19.5

3 years ago

1.19.4

3 years ago

1.19.0

3 years ago

1.19.3

3 years ago

1.19.2

3 years ago

1.19.1

3 years ago

1.18.5

3 years ago

1.18.4

3 years ago

1.18.3

3 years ago

1.18.1

3 years ago

1.18.2

3 years ago

1.18.0

3 years ago

1.17.13

3 years ago

1.17.11

3 years ago

1.17.12

3 years ago

1.17.10

3 years ago

1.17.9

3 years ago

1.17.8

3 years ago

1.17.6

3 years ago

1.17.7

3 years ago

1.17.5

3 years ago

1.17.4

3 years ago

1.16.10

3 years ago

1.16.11

3 years ago

1.16.9

3 years ago

1.16.8

3 years ago

1.17.2

3 years ago

1.17.1

3 years ago

1.17.0

3 years ago

1.17.3

3 years ago

1.16.7

3 years ago

1.16.6

3 years ago

1.16.5

3 years ago

1.16.2

3 years ago

1.16.0

3 years ago

1.15.0

3 years ago

1.14.1

3 years ago

1.14.3

3 years ago

1.14.2

3 years ago

1.13.0

3 years ago

1.14.0

3 years ago

1.12.8

3 years ago

1.12.7

3 years ago

1.12.6

3 years ago

1.12.5

3 years ago

1.12.3

3 years ago

1.12.2

3 years ago

1.12.4

3 years ago

1.12.1

3 years ago

1.12.0

3 years ago

1.11.3

3 years ago

1.11.2

3 years ago

1.11.1

3 years ago

1.11.0

3 years ago

1.10.5

3 years ago

1.10.4

3 years ago

1.10.2

3 years ago

1.10.1

3 years ago

1.10.0

3 years ago

1.9.0

3 years ago

1.8.0

3 years ago

1.7.24

3 years ago

1.7.21

3 years ago

1.7.22

3 years ago

1.7.23

3 years ago

1.7.19

3 years ago

1.7.17

3 years ago

1.7.15

3 years ago

1.7.16

3 years ago

1.7.13

3 years ago

1.7.14

3 years ago

1.7.12

3 years ago

1.7.11

3 years ago

1.7.10

3 years ago

1.7.9

3 years ago

1.7.8

3 years ago

1.7.7

3 years ago

1.7.6

3 years ago

1.7.5

3 years ago

1.7.4

3 years ago

1.7.3

3 years ago

1.7.2

3 years ago

1.7.1

3 years ago

1.7.0

3 years ago

1.6.0

3 years ago

1.5.12

3 years ago

1.5.10

3 years ago

1.5.11

3 years ago

1.5.9

3 years ago

1.5.8

3 years ago

1.5.7

3 years ago

1.5.6

3 years ago

1.5.5

3 years ago

1.5.4

3 years ago

1.5.3

3 years ago

1.5.2

3 years ago

1.5.1

3 years ago

1.5.0

3 years ago

1.4.1

4 years ago

1.4.0

4 years ago

1.0.151

4 years ago

1.0.150

4 years ago

1.0.149

4 years ago

1.0.145

4 years ago

1.0.147

4 years ago

1.0.146

4 years ago

1.0.148

4 years ago

1.0.144

4 years ago

1.0.143

4 years ago

1.0.142

4 years ago

1.0.141

4 years ago

1.0.140

4 years ago

1.0.139

4 years ago

1.0.138

4 years ago

1.0.137

4 years ago

1.0.136

4 years ago

1.0.135

4 years ago

1.0.134

4 years ago

1.0.133

4 years ago

1.0.132

4 years ago

1.0.131

4 years ago

1.0.130

4 years ago

1.0.129

4 years ago

1.0.128

4 years ago

1.0.127

4 years ago

1.0.126

4 years ago

1.0.125

4 years ago

1.0.123

4 years ago

1.0.124

4 years ago

1.0.122

4 years ago

1.0.121

4 years ago

1.0.120

4 years ago

1.0.119

4 years ago

1.0.118

4 years ago

1.0.117

4 years ago

1.0.116

4 years ago

1.0.114

4 years ago

1.0.115

4 years ago

1.0.112

4 years ago

1.0.113

4 years ago

1.0.111

4 years ago

1.0.109

4 years ago

1.0.110

4 years ago

1.0.108

4 years ago

1.0.107

4 years ago

1.0.106

4 years ago

1.0.105

4 years ago

1.0.104

4 years ago

1.0.103

4 years ago

1.0.102

4 years ago

1.0.101

4 years ago

1.0.100

4 years ago

1.0.99

4 years ago

1.0.98

4 years ago

1.0.97

4 years ago

1.0.95

4 years ago

1.0.96

4 years ago

1.0.94

4 years ago

1.0.93

4 years ago

1.0.92

4 years ago

1.0.91

4 years ago

1.0.90

4 years ago

1.0.89

4 years ago

1.0.88

4 years ago

1.0.87

4 years ago

1.0.86

4 years ago

1.0.85

4 years ago

1.0.84

4 years ago

1.0.83

4 years ago

1.0.80

4 years ago

1.0.82

4 years ago

1.0.81

4 years ago

1.0.79

4 years ago

1.0.78

4 years ago

1.0.77

4 years ago

1.0.76

4 years ago

1.0.75

4 years ago

1.0.74

4 years ago

1.0.73

4 years ago

1.0.72

4 years ago

1.0.71

4 years ago

1.0.70

4 years ago

1.0.69

4 years ago

1.0.68

4 years ago

1.0.67

4 years ago

1.0.66

4 years ago

1.0.65

4 years ago

1.0.64

4 years ago

1.0.63

4 years ago

1.0.62

4 years ago

1.0.61

4 years ago

1.0.60

4 years ago

1.0.59

4 years ago

1.0.58

4 years ago

1.0.57

4 years ago

1.0.55

4 years ago

1.0.54

4 years ago

1.0.56

4 years ago

1.0.53

4 years ago

1.0.51

4 years ago

1.0.52

4 years ago

1.0.50

4 years ago

1.0.48

4 years ago

1.0.47

4 years ago

1.0.49

4 years ago

1.0.46

4 years ago

1.0.45

4 years ago

1.0.44

4 years ago

1.0.43

4 years ago

1.0.42

4 years ago

1.0.41

4 years ago

1.0.39

4 years ago

1.0.40

4 years ago

1.0.38

4 years ago

1.0.37

4 years ago

1.0.36

4 years ago

1.0.33

4 years ago

1.0.35

4 years ago

1.0.34

4 years ago

1.0.32

4 years ago

1.0.31

4 years ago

1.0.30

4 years ago

1.0.29

5 years ago

1.0.28

5 years ago

1.0.27

5 years ago

1.0.26

5 years ago

1.0.25

5 years ago

1.0.24

5 years ago

1.0.23

5 years ago

1.0.22

5 years ago

1.0.21

5 years ago