@identity-js/identity 1.0.0

package/README.md

@@ -0,0 +1,55 @@
+# `@identity-js/identity`
+
+Introducing Identity.js, the 10x identity function.
+
+The identity function, $I(x)$, is a mathematical function that always returns the same value that was used as its argument, i.e., $I(x) = x$. This utility is often used in functional programming paradigms.
+
+At [10x'ly](https://10xengineersqualityprogramming.github.io), we are always looking for new opportunities to make 10x libraries and then it struck us: what about an identity function? This package spreads **10x'ness** into the simple concept of an identity function. It's not just an identity function, it's a **10x identity function**.
+
+## 💾 Installation
+
+This project is a standard Node.js module.
+
+```bash
+npm install @identity-js/identity
+```
+
+## 🚀 Usage
+
+The function accepts a single argument of any type and returns that argument unchanged.
+
+### Importing
+
+```javascript
+const identity = require("@identity-js/identity"); 
+```
+
+### Examples
+
+| Input Type | Code | Output |
+| :--- | :--- | :--- |
+| **Number** | `identity(42)` | `42` |
+| **String** | `identity('hello')` | `'hello'` |
+| **Object** | `const obj = {a: 1}; identity(obj)` | `// returns the same object reference: {a: 1}` |
+| **Null** | `identity(null)` | `null` |
+
+## ✅ Testing
+
+Tests are written using **Mocha**.
+
+### Prerequisites
+Clone this repository and install dependencies and dev-dependencies.
+
+### Running Tests
+
+Execute the test suite :
+
+```
+npm test
+```
+
+This will execute the tests to ensure the function works correctly across various data types (numbers, strings, objects, booleans, `null`, and `undefined`).
+
+## ✍️ License
+
+This project is licensed under the Unlicense.

package/index.js

@@ -0,0 +1,35 @@
+var stringIdentity = require("@identity-js/string-identity")
+var numberIdentity = require("@identity-js/number-identity")
+var lodashIdentity = require("lodash.identity")
+var vValue = require("vvalue")
+var fIdentity = require("@f/identity")
+var stdlibIdentity = require("@stdlib/utils-identity-function")
+var vretriever = require("vretriever")
+var immo = require("@_immo/return")
+var isuseless = require("is-useless").isuseless
+var falsevalue = require("false-value")()
+var identityfunction = require("identity-function")
+
+function identityCore(value) {
+  if (typeof value === "string") {
+    return stringIdentity(value)
+  } else if (typeof value === "number" || Number.isFinite(value)) {
+    var result = numberIdentity(value)
+    if (result === 0 && value !== 0) {
+      return value
+    } else {
+      return result
+    }
+  } else {
+    return value
+  }
+}
+
+function identity(value) {
+  if (value === null || value === undefined) {
+    return value
+  }
+  return identityfunction(vretriever.retrieve(immo(isuseless(stdlibIdentity(fIdentity(vValue(lodashIdentity(identityCore(value))))), falsevalue, falsevalue))))
+}
+
+module.exports = identity

package/license

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@identity-js/identity",
+  "version": "1.0.0",
+  "description": "Returns the value passed into the function.",
+  "keywords": [
+    "identity-js"
+  ],
+  "homepage": "https://github.com/10xEngineersQualityProgramming/identity#readme",
+  "bugs": {
+    "url": "https://github.com/10xEngineersQualityProgramming/identity/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/10xEngineersQualityProgramming/identity.git"
+  },
+  "license": "Unlicense",
+  "author": "me",
+  "type": "commonjs",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha test/index.js"
+  },
+  "dependencies": {
+    "@_immo/return": "^1.1.1",
+    "@f/identity": "^1.1.1",
+    "@identity-js/number-identity": "^1.1.0",
+    "@identity-js/string-identity": "^1.1.0",
+    "@stdlib/utils-identity-function": "^0.2.2",
+    "false-value": "^2.0.1",
+    "identity-function": "^1.0.0",
+    "is-useless": "^1.3.4",
+    "lodash.identity": "^3.0.0",
+    "vretriever": "^1.0.1",
+    "vvalue": "^1.0.0"
+  },
+  "devDependencies": {
+    "chai": "^6.2.1",
+    "mocha": "^11.7.5"
+  }
+}

package/test/index.js

@@ -0,0 +1,37 @@
+const assert = require('chai').assert
+const identity = require('../index')
+
+describe('identity()', () => {
+
+  it('should return the same number that was passed in', () => {
+    const input = 42
+    assert.strictEqual(identity(input), 42, 'The function should return the number 42.')
+  })
+  
+  it('should return the same string that was passed in', () => {
+    const input = 'hello world'
+    assert.strictEqual(identity(input), 'hello world', 'The function should return the string "hello world".')
+  })
+
+  it('should return the same object reference that was passed in', () => {
+    const inputObject = { a: 1, b: 'test' }
+    const result = identity(inputObject)
+    assert.strictEqual(result, inputObject, 'The function should return the exact same object reference.')
+    assert.deepEqual(result, { a: 1, b: 'test' }, 'The object content should be the same.')
+  })
+
+  it('should return the same boolean value (true)', () => {
+    const input = true
+    assert.strictEqual(identity(input), true, 'The function should return the boolean true.')
+  })
+
+  it('should return null when null is passed in', () => {
+    const input = null
+    assert.strictEqual(identity(input), null, 'The function should return null.')
+  })
+
+  it('should return undefined when undefined is passed in', () => {
+    const input = undefined
+    assert.strictEqual(identity(input), undefined, 'The function should return undefined.')
+  })
+})