@chubbyts/chubbyts-decode-encode 1.0.4 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/decoder/index.d.ts +1 -1
- package/dist/encoder/index.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,7 +34,7 @@ A simple decode/encode solution for json / jsonx / url-encoded / xml / yaml.
|
|
|
34
34
|
Through [NPM](https://www.npmjs.com) as [@chubbyts/chubbyts-decode-encode][1].
|
|
35
35
|
|
|
36
36
|
```ts
|
|
37
|
-
npm i @chubbyts/chubbyts-decode-encode@^1.0
|
|
37
|
+
npm i @chubbyts/chubbyts-decode-encode@^1.1.0
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
## Usage
|
|
@@ -48,7 +48,7 @@ import { createDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder';
|
|
|
48
48
|
import { createJsonTypeDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder/json-type-decoder';
|
|
49
49
|
|
|
50
50
|
const decoder = createDecoder([createJsonTypeDecoder()]);
|
|
51
|
-
const data = decoder.decode('{"key":"value"}', 'application/json');
|
|
51
|
+
const data = decoder.decode('{"key":"value"}', 'application/json'); // or with 3th argument, for example { user: 'username1' }
|
|
52
52
|
// data: {key: "value"}
|
|
53
53
|
const contentTypes = decoder.contentTypes;
|
|
54
54
|
// contentTypes: ['application/json']
|
|
@@ -88,7 +88,7 @@ const contentType = jsonxTypeDecoder.contentType;
|
|
|
88
88
|
```ts
|
|
89
89
|
import { createUrlEncodedTypeDecoder } from '@chubbyts/chubbyts-decode-encode/dist/decoder/url-encoded-type-decoder';
|
|
90
90
|
|
|
91
|
-
const urlEncodedTypeDecoder = createUrlEncodedTypeDecoder()
|
|
91
|
+
const urlEncodedTypeDecoder = createUrlEncodedTypeDecoder();
|
|
92
92
|
const data = urlEncodedTypeDecoder.decode('key=value');
|
|
93
93
|
// data: {key: "value"}
|
|
94
94
|
const contentType = urlEncodedTypeDecoder.contentType;
|
|
@@ -116,7 +116,7 @@ import { createEncoder } from '@chubbyts/chubbyts-encode-encode/dist/encoder';
|
|
|
116
116
|
import { createJsonTypeEncoder } from '@chubbyts/chubbyts-encode-encode/dist/encoder/json-type-encoder';
|
|
117
117
|
|
|
118
118
|
const encoder = createEncoder([createJsonTypeEncoder()]);
|
|
119
|
-
const encodedData = encoder.encode({key: "value"}, 'application/json');
|
|
119
|
+
const encodedData = encoder.encode({key: "value"}, 'application/json'); // or with 3th argument, for example { user: 'username1' }
|
|
120
120
|
// encodedData: {"key":"value"}
|
|
121
121
|
const contentTypes = encoder.contentTypes;
|
|
122
122
|
// contentTypes: ['application/json']
|
package/dist/decoder/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export declare type TypeDecoder = {
|
|
|
6
6
|
contentType: string;
|
|
7
7
|
};
|
|
8
8
|
export declare type Decoder = {
|
|
9
|
-
decode: (encodedData: string, contentType: string) => Data;
|
|
9
|
+
decode: (encodedData: string, contentType: string, context?: Record<string, unknown>) => Data;
|
|
10
10
|
contentTypes: Array<string>;
|
|
11
11
|
};
|
|
12
12
|
export declare const createDecoder: (decoderTypes: Array<TypeDecoder>) => Decoder;
|
package/dist/encoder/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ export declare type TypeEncoder = {
|
|
|
6
6
|
contentType: string;
|
|
7
7
|
};
|
|
8
8
|
export declare type Encoder = {
|
|
9
|
-
encode: (data: Data, contentType: string) => string;
|
|
9
|
+
encode: (data: Data, contentType: string, context?: Record<string, unknown>) => string;
|
|
10
10
|
contentTypes: Array<string>;
|
|
11
11
|
};
|
|
12
12
|
export declare const createEncoder: (encoderTypes: Array<TypeEncoder>) => Encoder;
|