@thi.ng/emoji 0.1.44 → 0.2.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-07-22T13:15:57Z
+- **Last updated**: 2024-08-18T14:11:34Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [0.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/emoji@0.2.0) (2024-08-10)
+
+#### 🚀 Features
+
+- add replaceNames(), add test ([a9726c8](https://github.com/thi-ng/umbrella/commit/a9726c8))
+
 ## [0.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/emoji@0.1.0) (2023-02-27)
 
 #### 🚀 Features

package/README.md

@@ -7,7 +7,7 @@
 [![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 > [!NOTE]
-> This is one of 198 standalone projects, maintained as part
+> This is one of 199 standalone projects, maintained as part
 > of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo
 > and anti-framework.
 >
@@ -30,7 +30,11 @@ Bi-directional lookup tables mapping emoji names & their characters.
 There're lots of other emoji packages available, most of them with various
 additional functionality & dependencies. In contrast, this package merely
 provides simple bi-directional mappings between emoji names & their actual
-characters. Nothing more, nothing less.
+characters.
+
+The function [`replaceNames()`]() can be used to replace all _known_
+`:emoji_name:` occurrences in a given string with their corresponding emoji
+character...
 
 ### References
 
@@ -76,7 +80,7 @@ For Node.js REPL:
 const emoji = await import("@thi.ng/emoji");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 11.78 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 11.84 KB
 
 ## Dependencies
 
@@ -86,14 +90,17 @@ None
 
 [Generated API docs](https://docs.thi.ng/umbrella/emoji/)
 
-```ts
-import { EMOJI, NAMES } from "@thi.ng/emoji";
+```ts tangle:export/readme.ts
+import { EMOJI, NAMES, replaceNames } from "@thi.ng/emoji";
 
-EMOJI["minibus"]
+console.log(EMOJI["minibus"]);
 // "🚐"
 
-NAMES["🚐"]
+console.log(NAMES["🚐"]);
 // "minibus"
+
+console.log(replaceNames("Amazing :grin::heart_eyes::invalid:!"));
+// "Amazing 😁😍:invalid:!"
 ```
 
 ## Authors

package/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./emoji.js";
 export * from "./names.js";
+export * from "./replace.js";
 //# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,2 +1,3 @@
 export * from "./emoji.js";
 export * from "./names.js";
+export * from "./replace.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/emoji",
-  "version": "0.1.44",
+  "version": "0.2.1",
   "description": "Bi-directional lookup tables mapping emoji names & their characters",
   "type": "module",
   "module": "./index.js",
@@ -36,10 +36,10 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.47.0",
+    "@microsoft/api-extractor": "^7.47.5",
     "esbuild": "^0.23.0",
-    "typedoc": "^0.26.3",
-    "typescript": "^5.5.3"
+    "typedoc": "^0.26.5",
+    "typescript": "^5.5.4"
   },
   "keywords": [
     "bidirectional",
@@ -74,11 +74,14 @@
     },
     "./names": {
       "default": "./names.js"
+    },
+    "./replace": {
+      "default": "./replace.js"
     }
   },
   "thi.ng": {
     "status": "alpha",
     "year": 2023
   },
-  "gitHead": "324d6b7dbf31558329e9fb6452e29b2f7db9c61a\n"
+  "gitHead": "f6e26ea1142525171de5d36b9c3119f2782bb437\n"
 }

package/replace.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Takes a string and replaces all known `:emoji_name:` occurrences with their
+ * actual emoji character.
+ *
+ * @param src
+ */
+export declare const replaceNames: (src: string) => string;
+//# sourceMappingURL=replace.d.ts.map

package/replace.js

@@ -0,0 +1,5 @@
+import { EMOJI } from "./emoji.js";
+const replaceNames = (src) => src.replace(/:([a-z0-9_+-]+):/g, (orig, id) => EMOJI[id] || orig);
+export {
+  replaceNames
+};