Skip to content

Commit f020e6f

Browse files
committed
update dependencies to fix #18
1 parent 4720487 commit f020e6f

File tree

4 files changed

+1816
-4110
lines changed

4 files changed

+1816
-4110
lines changed

README.md

+4-15
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,11 @@ Utility function that creates an Error suitable for gRPC responses
1313

1414
[grpc status codes](https://grpc.io/grpc/node/grpc.html) - The grpc status codes.
1515

16-
## Installation
17-
```bash
18-
npm install create-grpc-error --save
19-
```
20-
2116
## API
2217

2318
<a name="createGRPCError"></a>
2419

25-
### createGRPCError(message, code, metadata) ⇒ <code>Error</code>
20+
### createGRPCError([message], [code], [metadata]) ⇒ <code>Error</code>
2621
Utility function that creates an Error suitable for gRPC responses.
2722
See tests for all examples
2823

@@ -31,20 +26,17 @@ See tests for all examples
3126

3227
| Param | Type | Description |
3328
| --- | --- | --- |
34-
| message | <code>String</code> \| <code>Number</code> \| <code>Error</code> \| <code>Object</code> | If <code>String</code> the error message If <code>Number</code> the error code If instanceof <code>Error</code>, the error to source data from. We still create a new <code>Error</code> instance, copy data from the passed error and assign / merge the rest of arguments. This can be used to mege metadata of existing error with additional metadata. If <code>Object</code>, assumed to be metadata, either plain object representation or actual <code>grpc.Metadata</code> instance. We use <code>grpc-create-metadata</code> module to create metadata for the return value. |
35-
| code | <code>Number</code> \| <code>Object</code> | If <code>Number</code> the error code If <code>Object</code>, assumed to be metadata, either plain object representation or actual <code>grpc.Metadata</code> instance. We use <code>grpc-create-metadata</code> module to create metadata for the return value. |
36-
| metadata | <code>Object</code> | The error metadata. Either plain object representation or actual <code>grpc.Metadata</code> instance. We use <code>grpc-create-metadata</code> module to create metadata for the return value. |
29+
| [message] | <code>String</code> \| <code>Number</code> \| <code>Error</code> \| <code>Object</code> | If <code>String</code> the error message If <code>Number</code> the error code If instanceof <code>Error</code>, the error to source data from. We still create a new <code>Error</code> instance, copy data from the passed error and assign / merge the rest of arguments. This can be used to mege metadata of existing error with additional metadata. If <code>Object</code>, assumed to be metadata, either plain object representation or actual <code>grpc.Metadata</code> instance. We use <code>grpc-create-metadata</code> module to create metadata for the return value. |
30+
| [code] | <code>Number</code> \| <code>Object</code> | If <code>Number</code> the error code If <code>Object</code>, assumed to be metadata, either plain object representation or actual <code>grpc.Metadata</code> instance. We use <code>grpc-create-metadata</code> module to create metadata for the return value. |
31+
| [metadata] | <code>Object</code> | The error metadata. Either plain object representation or actual <code>grpc.Metadata</code> instance. We use <code>grpc-create-metadata</code> module to create metadata for the return value. |
3732

3833
**Example** *(Using standard grpc status code)*
39-
4034
```js
4135
const grpc = require('grpc')
4236
const createGRPCError = require('create-grpc-error')
4337
const err = createGRPCError('Ouch!', grpc.status.INVALID_ARGUMENT)
4438
```
45-
4639
**Example** *(Custom error with metadata)*
47-
4840
```js
4941
const createGRPCError = require('create-grpc-error')
5042
const err = createGRPCError('Boom', 2000, { ERROR_CODE: 'INVALID_TOKEN' })
@@ -53,9 +45,7 @@ console.log(err.code) // 2000
5345
console.log(err.metadata instanceof grpc.Metadata) // true
5446
console.log(err.metadata.getMap()) // { error_code: 'INVALID_TOKEN' }
5547
```
56-
5748
**Example** *(Source from error and merge metadatas)*
58-
5949
```js
6050
const createGRPCError = require('create-grpc-error')
6151

@@ -69,7 +59,6 @@ console.log(err.code) // 2000
6959
console.log(err.metadata instanceof grpc.Metadata) // true
7060
console.log(err.metadata.getMap()) // { foo: 'bar', error_code: 'INVALID_TOKEN' }
7161
```
72-
7362
<a name="applyCreate"></a>
7463

7564
### applyCreate(err, message, code, metadata) ⇒ <code>Error</code>

0 commit comments

Comments
 (0)