@mavogel/awscdk-rootmail 0.1.37 → 0.1.39

package/node_modules/encoding-japanese/README.md

@@ -59,8 +59,9 @@ Since JavaScript string values are internally encoded as UTF-16 code units
 data in other encodings cannot be handled directly as JavaScript strings.
 encoding.js works around this limitation by representing encoded data as arrays of numeric code values instead of strings, enabling conversion between different character encodings.
 For example, `[130, 160]` represents "あ" in Shift_JIS.
+When passing these character code arrays to encoding.js methods, you can use regular arrays as well as typed arrays (such as `Uint8Array`) or Node.js `Buffer` objects.
 
-These character code arrays can also be passed as typed arrays (such as `Uint8Array`) or as Node.js `Buffer` objects.
+The source code of encoding.js itself is written using only ASCII characters, except for comments. This makes it easy to work with when embedded in other code or used in environments with limited character support.
 
 ### How to Handle Encoded Data as Strings?
 
@@ -97,12 +98,16 @@ const Encoding = require('encoding-japanese');
 
 #### TypeScript
 
-TypeScript type definitions for encoding.js are available at [@types/encoding-japanese](https://www.npmjs.com/package/@types/encoding-japanese) (thanks to [@rhysd](https://github.com/rhysd)).
+As of version 2.4.0, encoding.js includes TypeScript type definitions (`index.d.ts`), so no additional package is required.
+
+After upgrading to v2.4.0 or later, you can remove `@types/encoding-japanese` if installed:
 
 ```bash
-npm install --save-dev @types/encoding-japanese
+npm uninstall @types/encoding-japanese
 ```
 
+The type definitions were originally maintained on DefinitelyTyped (thanks to [@rhysd](https://github.com/rhysd) and [@peterblazejewicz](https://github.com/peterblazejewicz)).
+
 ### Browser (standalone)
 
 To use encoding.js in a browser environment, you can either install it via npm or download it directly from the [release list](https://github.com/polygonplanet/encoding.js/tags).
@@ -125,7 +130,7 @@ When the script is loaded, the object `Encoding` is defined in the global scope
 You can use encoding.js (package name: `encoding-japanese`) directly from a CDN via a script tag:
 
 ```html
-<script src="https://unpkg.com/encoding-japanese@2.4.0/encoding.min.js"></script>
+<script src="https://unpkg.com/encoding-japanese@2.5.0/encoding.min.js"></script>
 ```
 
 In this example we use [unpkg](https://unpkg.com/encoding-japanese/), but you can use any CDN that provides npm packages,
@@ -396,7 +401,7 @@ The following `type` options are supported.
 
 * **string** : Return as a string.
 * **arraybuffer** : Return a `Uint16Array` (the option name is retained for historical reasons).
-* **array** : Return as an Array. (*default*)
+* **array** : Return as a new Array. (*default*)
 
 `type: 'string'` can be used as a shorthand for converting a code array to a string,
 as performed by [`Encoding.codeToString`](#encodingcodetostring-code).