@xylabs/function-name 4.13.19 → 4.13.21

package/README.md

@@ -12,13 +12,41 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.15
 
-Primary SDK for using XYO Protocol 2.0
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Documentation
+## API Documentation
+
+**@xylabs/function-name**
+
+***
+
+## Functions
+
+- [functionName](#functions/functionName)
+
+### functions
+
+  ### <a id="functionName"></a>functionName
+
+[**@xylabs/function-name**](#../README)
+
+***
+
+```ts
+function functionName(depth): string;
+```
+
+## Parameters
+
+### depth
+
+`number` = `2`
+
+## Returns
+
+`string`
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xylabs/function-name",
-  "version": "4.13.19",
-  "description": "Primary SDK for using XYO Protocol 2.0",
+  "version": "4.13.21",
+  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "function",
     "name",
@@ -30,19 +30,25 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
-  "types": "dist/neutral/index.d.ts",
+  "module": "./dist/neutral/index.mjs",
+  "source": "./src/index.ts",
+  "types": "./dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/error": "^4.13.19",
-    "@xylabs/typeof": "^4.13.19"
+    "@xylabs/error": "^4.13.21",
+    "@xylabs/typeof": "^4.13.21"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
-    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0",
+    "@xylabs/tsconfig": "^7.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/functionName.spec.ts

@@ -0,0 +1,58 @@
+import {
+  describe, expect, test,
+} from 'vitest'
+
+import { functionName } from '../functionName.ts'
+
+describe('Logger', () => {
+  test('getFunctionName:function', () => {
+    const test = () => {
+      return functionName()
+    }
+    const funcName = test()
+    expect(funcName).toBe('test')
+  })
+  test('getFunctionName:constructor', () => {
+    class Foo {
+      funcName: string
+      constructor() {
+        this.funcName = functionName()
+      }
+    }
+
+    const foo = new Foo()
+    expect(foo.funcName).toBe('new Foo')
+  })
+
+  test('getFunctionName:method', () => {
+    class Foo {
+      funcName: string
+      constructor() {
+        this.funcName = this.test()
+      }
+
+      test() {
+        return functionName()
+      }
+    }
+
+    const foo = new Foo()
+    expect(foo.funcName).toBe('Foo.test')
+  })
+
+  test('getFunctionName:static', () => {
+    class Foo {
+      funcName: string
+      constructor() {
+        this.funcName = Foo.test()
+      }
+
+      static test() {
+        return functionName()
+      }
+    }
+
+    const foo = new Foo()
+    expect(foo.funcName).toBe('Function.test')
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/types.d.ts

@@ -1,3 +0,0 @@
-declare global {
-  let console: Logger
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config