Make back into a cjs package

PythonCoderAS · PythonCoderAS · commit 81ae149bd06e · 2021-12-18T15:40:19.000-05:00
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # array-string-map
+
 ![node-current](https://img.shields.io/node/v/array-string-map)
 [![npm](https://img.shields.io/npm/v/array-string-map)](https://www.npmjs.com/package/array-string-map)
 [![npm](https://img.shields.io/npm/dt/array-string-map)](https://www.npmjs.com/package/array-string-map)
@@ -9,4 +10,29 @@ A Map that internally encodes Arrays to strings so that two Arrays with the same
 
 ## Motivation
 
-I was using a Map to store array values, and I kept on running into a bug where I could not get those values back. I got fed up, and then after some Googling, realized that array lookups will not work when two different arrays with the same elements are used (such as when I use array literal syntax to create them). My solution was to encode the values as string keys.
+I was using a Map to store array values, and I kept on running into a bug where I could not get those values back. I got
+fed up, and then after some Googling, realized that array lookups will not work when two different arrays with the same
+elements are used (such as when I use array literal syntax to create them). My solution was to encode the values as
+string keys.
+
+## Usage
+
+ESM modules or TypeScript scripts can just import the normal way, such as:
+
+```ts
+import ArrayStringMap from 'array-string-map'
+```
+
+However, for CommonJS modules, you need to use the `require` function, such as:
+
+```js
+const {default: ArrayStringMap} = require("./arrayStringMap")
+```
+
+## API
+
+### ArrayStringMap
+
+A class that implements the [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map)
+interface. All methods that can be used on a Map are available on the ArrayStringMap.
+
diff --git a/arrayStringMap.test.ts b/arrayStringMap.test.ts
@@ -1,5 +1,5 @@
 import { assert } from "chai"
-import ArrayStringMap from "./arrayStringMap.js"
+import ArrayStringMap from "./arrayStringMap"
 
 type TwoNumberArray = [number, number]
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "array-string-map",
   "version": "2.0.0",
   "description": "A Map that internally encodes Arrays to strings so that two Arrays with the same elements will return the same item.",
-  "type": "module",
+  "type": "commonjs",
   "main": "arrayStringMap.js",
   "types": "arrayStringMap.d.ts",
   "scripts": {
@@ -29,6 +29,7 @@
   "devDependencies": {
     "@types/chai": "^4.3.0",
     "@types/mocha": "^9.0.0",
+    "@types/node": "^17.0.0",
     "chai": "^4.3.4",
     "mocha": "^9.1.3",
     "typescript": "^4.5.4"
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "module": "esnext",
+    "module": "commonjs",
     "target": "es2019",
     "strict": true,
     "allowJs": true,

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"compilerOptions": {`
`3`		`- "module": "esnext",`
	`3`	`+ "module": "commonjs",`
`4`	`4`	`"target": "es2019",`
`5`	`5`	`"strict": true,`
`6`	`6`	`"allowJs": true,`