orc-me 1.2.6 → 1.2.8

package/README.md

@@ -18,6 +18,7 @@
 * ✨ Get awesome orc names for your projects!
 * 👹 An orc name is created by starting with a harsh consonant sound (like `gr`, `kr`, `th`, or `sh`), followed by a short, heavy vowel (`a`, `o`, or `u`), and usually ending with another hard consonant (`g`, `k`, `r`, or `z`). Sometimes an extra harsh sound is added at the end to make the name feel more brutal.
 * ⭐ Updated the version using a custom `orc phoneme grammar` to avoid hardcoded array of names.
+* ♻️ Works seamlessly with `CommonJS`, `ESM` and `TypeScript`
 
 # Install [NPM](https://www.npmjs.com/package/orc-me) 📦
 
@@ -29,6 +30,7 @@
 
 # Examples 💻
 
+## CommonJS
 ``` javascript
 const orcMe = require('orc-me');
 
@@ -39,6 +41,28 @@ console.log('Orc battle started! ⚔️');
 console.log(orcThreeNames + '    ⚔️     ' + orcTwoNames);
 ```
 
+## ESM
+```javascript
+import orcMe from 'orc-me';
+
+const orcThreeNames = `${orcMe()} ${orcMe()} ${orcMe()}`;
+const orcTwoNames = `${orcMe()} ${orcMe()}`;
+
+console.log('Orc battle started! ⚔️');
+console.log(orcThreeNames + '    ⚔️     ' + orcTwoNames);
+```
+
+## TypeScript
+```javascript
+import orcMe from 'orc-me';
+
+const orcThreeNames: string = `${orcMe()} ${orcMe()} ${orcMe()}`;
+const orcTwoNames: string = `${orcMe()} ${orcMe()}`;
+
+console.log('Orc battle started! ⚔️');
+console.log(`${orcThreeNames}    ⚔️     ${orcTwoNames}`);
+```
+
 # Result of the example above
 
 <p align="center">

package/index.d.ts

@@ -3,6 +3,6 @@
  *
  * @returns A randomly generated orc name as a string
  */
-declare function orcName(): string;
+declare function orcMe(): string;
 
-export = orcName;
+export = orcMe;

package/index.js

@@ -1,6 +1,6 @@
 /**
  *  orc-me - 👹 Generate a random orc name
- *  @version: v1.2.6
+ *  @version: v1.2.8
  *  @link: https://github.com/tutyamxx/orc-me
  *  @license: MIT
  **/
@@ -39,4 +39,8 @@ const orcMe = () => {
     return `${onset}${vowel}${coda}${extra}${secondSyllable}`?.replace?.(/^./, c => c.toUpperCase()) ?? '';
 };
 
+// --| CommonJS export
 module.exports = orcMe;
+
+// --| ESM default export for `import` statements
+module.exports.default = orcMe;

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "orc-me",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "Generate a random orc name",
   "main": "index.js",
-  "type": "module",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    "require": "./index.js",
+    "import": "./index.js",
+    "types": "./index.d.ts"
+  },
   "scripts": {
     "test": "jest --verbose"
   },