new definitions: 'encoding-japanese' module (#8974)

Project: https://github.com/polygonplanet/encoding.js
2026-03-29 17:08:21 +08:00 · 2016-04-17 22:35:00 +09:00
parent 8363db45d1
commit cf9955fe1c
2 changed files with 144 additions and 0 deletions
--- a/encoding-japanese/encoding-japanese-tests.ts
+++ b/encoding-japanese/encoding-japanese-tests.ts
@@ -0,0 +1,95 @@
+/// <reference path="./encoding-japanese.d.ts" />
+
+import * as Encoding from 'encoding-japanese';
+
+// Convert character encoding to Shift_JIS from UTF-8.
+var utf8Array_1 = new Uint8Array([1, 2, 3]);
+var utf8Array_2 = [1, 2, 3];
+var utf8Array_3 = new Buffer([1, 2, 3]);
+var sjisArray = Encoding.convert(utf8Array_1, 'SJIS', 'UTF8');
+var sjisArray = Encoding.convert(utf8Array_2, 'UTF16', 'UTF8');
+var sjisArray = Encoding.convert(utf8Array_3, 'EUCJP', 'UTF8');
+
+// Convert character encoding by automatic detection (AUTO detect).
+var utf8Array = utf8Array_1;
+var sjisArray1 = Encoding.convert(utf8Array, 'SJIS');
+// or  
+var sjisArray2 = Encoding.convert(utf8Array, 'SJIS', 'AUTO');
+
+// Detect the character encoding.
+// The return value be one of the "Available Encodings" below.
+var detected = Encoding.detect(utf8Array);
+if (detected === 'UTF8') {
+  console.log('Encoding is UTF-8');
+}
+
+var sjisArray3 = Encoding.convert(utf8Array, {
+  to: 'SJIS', // to_encoding
+  from: 'UTF8' // from_encoding
+});
+
+var utf8String = 'ã\u0081\u0093ã\u0082\u0093ã\u0081«ã\u0081¡ã\u0081¯';
+var unicodeString = Encoding.convert(utf8String, {
+  to: 'UNICODE',
+  from: 'UTF8',
+  type: 'string' // Specify 'string' type. (Return as string)
+});
+console.log(unicodeString); // こんにちは
+
+var utf16Array = Encoding.convert(utf8Array, {
+  to: 'UTF16', // to_encoding
+  from: 'UTF8', // from_encoding
+  bom: true // With BOM
+});
+
+var utf16leArray = Encoding.convert(utf8Array, {
+  to: 'UTF16', // to_encoding
+  from: 'UTF8', // from_encoding
+  bom: 'LE' // With BOM (little-endian)
+});
+
+var utf16beArray = Encoding.convert(utf8Array, {
+  to: 'UTF16BE',
+  from: 'UTF8'
+});
+
+// Detect character encoding by automatic. (AUTO detect).
+var detected2 = Encoding.detect(utf8Array);
+if (detected2 === 'UTF8') {
+  console.log('Encoding is UTF-8');
+}
+
+// Detect character encoding by specific encoding name.
+var isSJIS = Encoding.detect(sjisArray, 'SJIS');
+if (isSJIS) {
+  console.log('Encoding is SJIS');
+}
+
+var sjisArray4 = [
+  130, 177, 130, 241, 130, 201, 130, 191, 130, 205, 129,
+  65, 130, 217, 130, 176, 129, 153, 130, 210, 130, 230
+];
+
+var encoded = Encoding.urlEncode(sjisArray4);
+console.log(encoded);
+// output:
+// '%82%B1%82%F1%82%C9%82%BF%82%CD%81A%82%D9%82%B0%81%99%82%D2%82%E6'
+
+var decoded = Encoding.urlDecode(encoded);
+console.log(decoded);
+// output: [
+//   130, 177, 130, 241, 130, 201, 130, 191, 130, 205, 129,
+//    65, 130, 217, 130, 176, 129, 153, 130, 210, 130, 230
+// ]
+
+var sjisArray5 = [
+  130, 177, 130, 241, 130, 201, 130, 191, 130, 205
+];
+var encoded2 = Encoding.base64Encode(sjisArray5);
+console.log(encoded2); // 'grGC8YLJgr+CzQ=='
+
+var decoded2 = Encoding.base64Decode(encoded2);
+console.log(decoded2);
+// [130, 177, 130, 241, 130, 201, 130, 191, 130, 205]
+
+
--- a/encoding-japanese/encoding-japanese.d.ts
+++ b/encoding-japanese/encoding-japanese.d.ts
@@ -0,0 +1,49 @@
+// Type definitions for encoding-japanese v1.0.24
+// Project: https://github.com/polygonplanet/encoding.js
+// Definitions by: rhysd <https://rhysd.github.io>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference path="../node/node.d.ts" />
+
+declare module "encoding-japanese" {
+	export type Encoding =
+		"UTF32"   | "UTF16"   | "UTF16BE" |
+		"UTF16LE" | "BINARY"  | "ASCII"   |
+		"JIS"     | "UTF8"    | "EUCJP"   |
+		"SJIS"    | "UNICODE" | "AUTO";
+	type RawType = string | Uint8Array | number[] | Buffer;
+
+	interface ConvertOptions {
+		to: Encoding;
+		from?: Encoding;
+		type?: "string" | "arraybuffer" | "array";
+		bom?: boolean | string;
+	}
+
+	export function detect(data: RawType, encodings?: Encoding | Encoding[]): Encoding;
+	export function convert(data: RawType, to: Encoding, from?: Encoding): number[];
+	export function convert(data: RawType, options: ConvertOptions): string | ArrayBuffer | number[];
+	export function urlEncode(data: number[] | Uint8Array): string;
+	export function urlDecode(data: string): number[];
+	export function base64Encode(data: number[] | Uint8Array): string;
+	export function base64Decode(data: string): number[];
+	export function codeToString(data: number[] | Uint8Array): string;
+	export function stringToCode(data: string): number[];
+	export function toHankakuCase(data: number[]): number[];
+	export function toHankakuCase(data: string): string;
+	export function toZenkakuCase(data: number[]): number[];
+	export function toZenkakuCase(data: string): string;
+	export function toHiraganaCase(data: number[]): number[];
+	export function toHiraganaCase(data: string): string;
+	export function toKatakanaCase(data: number[]): number[];
+	export function toKatakanaCase(data: string): string;
+	export function toHankanaCase(data: number[]): number[];
+	export function toHankanaCase(data: string): string;
+	export function toZenkanaCase(data: number[]): number[];
+	export function toZenkanaCase(data: string): string;
+	export function toHankakuSpace(data: number[]): number[];
+	export function toHankakuSpace(data: string): string;
+	export function toZenkakuSpace(data: number[]): number[];
+	export function toZenkakuSpace(data: string): string;
+}
+