@lppedd/kotlinx-charset 0.0.3 → 0.1.1

package/README.md

@@ -37,16 +37,17 @@ val encoder = charset.newEncoder()
 The `ebcdic` module adds support for:
 
 ```text
-IBM037
-IBM930
-IBM1047
+IBM037  IBM939   IBM1390
+IBM273  IBM1047  IBM1399
+IBM297  IBM1141
+IBM930  IBM1147
 ```
 
 You can register supported EBCDIC charsets to your `XCharsetRegistrar`
 via the `provideCharsets` function.
 
 ```kotlin
-import com.github.lppedd.kotlinx.charset.ebcdic.provideCharsets as provideEbcdicCharsets
+import com.lppedd.kotlinx.charset.ebcdic.provideCharsets as provideEbcdicCharsets
 
 // Your shared charset registry
 private val registrar = XCharsetRegistrar()
@@ -66,11 +67,23 @@ You can depend on the [@lppedd/kotlinx-charset][1] npm package.
 For example, consuming the library from TypeScript would look like:
 
 ```ts
-import { decode, encode } from "@lppedd/kotlinx-charset";
+import { decode, encode, getCharset } from "@lppedd/kotlinx-charset";
 
-function example(bytes: Uint8Array): Uint8Array {
-  const str = decode("cp037", bytes);
-  return encode("cp037", str);
+function funsExample(bytes: Uint8Array): Uint8Array {
+  const str = decode("ibm037", bytes);
+  return encode("ibm037", str);
+}
+
+// Alternatively, you can interact with a charset instance directly.
+// This allows setting or removing (by passing null) the replacement character.
+function instanceExample(bytes: Uint8Array): Uint8Array {
+  const charset = getCharset("ibm037");
+
+  const decoder = charset.newDecoder();
+  const str = decoder.decode(bytes);
+
+  const encoder = charset.newEncoder();
+  return encoder.encode(str);
 }
 ```
 

package/kotlinx-charset-exported.d.ts

@@ -1,14 +1,11 @@
 type Nullable<T> = T | null | undefined
-export declare function getCharset(charsetName: string): XCharset;
-export declare function decode(charsetName: string, bytes: Uint8Array): string;
-export declare function encode(charsetName: string, value: string): Uint8Array;
 export declare interface XCharset {
     readonly name: string;
     readonly aliases: Array<string>;
     newDecoder(): XCharsetDecoder;
     newEncoder(): XCharsetEncoder;
     readonly __doNotUseOrImplementIt: {
-        readonly "com.github.lppedd.kotlinx.charset.exported.XCharset": unique symbol;
+        readonly "com.lppedd.kotlinx.charset.exported.XCharset": unique symbol;
     };
 }
 export declare interface XCharsetDecoder {
@@ -16,7 +13,7 @@ export declare interface XCharsetDecoder {
     setReplacement(newReplacement: Nullable<string>): void;
     reset(): void;
     readonly __doNotUseOrImplementIt: {
-        readonly "com.github.lppedd.kotlinx.charset.exported.XCharsetDecoder": unique symbol;
+        readonly "com.lppedd.kotlinx.charset.exported.XCharsetDecoder": unique symbol;
     };
 }
 export declare interface XCharsetEncoder {
@@ -24,6 +21,9 @@ export declare interface XCharsetEncoder {
     setReplacement(newReplacement: Nullable<Uint8Array>): void;
     reset(): void;
     readonly __doNotUseOrImplementIt: {
-        readonly "com.github.lppedd.kotlinx.charset.exported.XCharsetEncoder": unique symbol;
+        readonly "com.lppedd.kotlinx.charset.exported.XCharsetEncoder": unique symbol;
     };
-}
+}
+export declare function getCharset(charsetName: string): XCharset;
+export declare function decode(charsetName: string, bytes: Uint8Array): string;
+export declare function encode(charsetName: string, value: string): Uint8Array;