@alwatr/flat-string 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# 1.0.0 (2023-12-20)
+
+### Bug Fixes
+
+* build process ([83fc4e6](https://github.com/Alwatr/nanolib/commit/83fc4e609f86c25291e5f89016d6777bf197ffcb)) by @AliMD
+
+### Features
+
+* **flat-string:** add new package for simplifies the complex C structures that are part of a combined JavaScript string ([ebfdcb3](https://github.com/Alwatr/nanolib/commit/ebfdcb368bc111e59d6b920f572d6365eef62144)) by @AliMD

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# Flat String
+
+This function simplifies the complex C structures that are part of a combined JavaScript string.
+
+If you're frequently combining strings and then using that combined string somewhere else, you might discover that running your string through `flatString` significantly enhances performance.
+
+In simpler terms, `flatString` is a function that optimizes the way strings are stored in memory in JavaScript. When you concatenate strings, JavaScript internally creates a complex structure to save memory. However, when you need to use this string, for example, to write it to a file or send it over the network, this complex structure needs to be flattened, which can take time. By using `flatString`, you flatten the string right after concatenation, making the subsequent use of the string faster.

package/dist/main.cjs

@@ -0,0 +1,3 @@
+/* @alwatr/flat-string v1.0.0 */
+"use strict";var g=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var o=Object.getOwnPropertyNames;var u=Object.prototype.hasOwnProperty;var a=(n,t)=>{for(var i in t)g(n,i,{get:t[i],enumerable:!0})},c=(n,t,i,e)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of o(t))!u.call(n,r)&&r!==i&&g(n,r,{get:()=>t[r],enumerable:!(e=f(t,r))||e.enumerable});return n};var l=n=>c(g({},"__esModule",{value:!0}),n);var s={};a(s,{flatString:()=>p});module.exports=l(s);function p(n){return n|0,n}0&&(module.exports={flatString});
+//# sourceMappingURL=main.cjs.map

package/dist/main.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n * This function simplifies the complex C structures that are part of a combined JavaScript string.\n *\n * @param str The string to flatten.\n * @returns The flattened string.\n * @example\n * ```typescript\n * flatString(myStr);\n * ```\n */\nexport function flatString (str: string): string {\n  // @ts-expect-error because it alters wrong compilation errors.\n  str | 0;\n  return str;\n}\n"],
+  "mappings": ";yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,gBAAAE,IAAA,eAAAC,EAAAH,GAUO,SAASE,EAAYE,EAAqB,CAE/C,OAAAA,EAAM,EACCA,CACT",
+  "names": ["main_exports", "__export", "flatString", "__toCommonJS", "str"]
+}

package/dist/main.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This function simplifies the complex C structures that are part of a combined JavaScript string.
+ *
+ * @param str The string to flatten.
+ * @returns The flattened string.
+ * @example
+ * ```typescript
+ * flatString(myStr);
+ * ```
+ */
+export declare function flatString(str: string): string;
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAI/C"}

package/dist/main.mjs

@@ -0,0 +1,3 @@
+/* @alwatr/flat-string v1.0.0 */
+function t(n){return n|0,n}export{t as flatString};
+//# sourceMappingURL=main.mjs.map

package/dist/main.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/main.ts"],
+  "sourcesContent": ["/**\n * This function simplifies the complex C structures that are part of a combined JavaScript string.\n *\n * @param str The string to flatten.\n * @returns The flattened string.\n * @example\n * ```typescript\n * flatString(myStr);\n * ```\n */\nexport function flatString (str: string): string {\n  // @ts-expect-error because it alters wrong compilation errors.\n  str | 0;\n  return str;\n}\n"],
+  "mappings": ";AAUO,SAASA,EAAYC,EAAqB,CAE/C,OAAAA,EAAM,EACCA,CACT",
+  "names": ["flatString", "str"]
+}

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@alwatr/flat-string",
+  "version": "1.0.0",
+  "description": "The `flat-string` function flattens the underlying C structures of a concatenated JavaScript string.",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
+  "keywords": [
+    "string",
+    "flat",
+    "flatten",
+    "optimize",
+    "concat",
+    "util",
+    "typescript",
+    "esm",
+    "alwatr"
+  ],
+  "type": "module",
+  "main": "./dist/main.cjs",
+  "module": "./dist/main.mjs",
+  "types": "./dist/main.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/main.mjs",
+      "require": "./dist/main.cjs",
+      "types": "./dist/main.d.ts"
+    }
+  },
+  "license": "MIT",
+  "files": [
+    "**/*.{d.ts.map,d.ts,js.map,js,html,md,cjs,mjs,cjs.map,mjs.map}"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alwatr/nanolib",
+    "directory": "packages/flat-string"
+  },
+  "homepage": "https://github.com/Alwatr/nanolib/tree/next/packages/flat-string#readme",
+  "bugs": {
+    "url": "https://github.com/Alwatr/nanolib/issues"
+  },
+  "scripts": {
+    "b": "yarn run build",
+    "w": "yarn run watch",
+    "c": "yarn run clean",
+    "cb": "yarn run clean && yarn run build",
+    "d": "yarn run build:es && ALWATR_DEBUG=1 yarn node",
+    "build": "yarn run build:ts & yarn run build:es",
+    "build:es": "nano-build",
+    "build:ts": "tsc --build",
+    "watch": "yarn run watch:ts & yarn run watch:es",
+    "watch:es": "yarn run build:es --watch",
+    "watch:ts": "yarn run build:ts --watch --preserveWatchOutput",
+    "clean": "rm -rfv dist .tsbuildinfo"
+  },
+  "devDependencies": {
+    "@alwatr/nano-build": "^1.0.0",
+    "@alwatr/tsconfig-base": "^1.0.0",
+    "typescript": "^5.3.3"
+  },
+  "gitHead": "1896de798973e9de67df6d20e8451a957b985636"
+}