@wtasnorg/node-lib 0.0.1 → 0.0.3

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,36 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm clean-install
+      - run: npm run build
+      - run: npm run test
+      - run: npm run docs
+      - run: npm run docs:json
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm clean-install
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/README.md

@@ -1,8 +1,6 @@
 # @wtasnorg/node-lib
 
-A library project for nodejs.
-
-#typescript #library
+A library project for nodejs. #nodejs #typescript #library
 
 - [npm org](https://www.npmjs.com/org/wtasnorg)
 - [github repo](https://github.com/wtasg/node-lib)
@@ -28,7 +26,7 @@ npm install @wtasnorg/node-lib
 # check if you can run code
 import {hello} from "@wtasnorg/node-lib";
 
-hello(); 
+await hello(); 
 // "hello from @wtasnorg/node-lib"
 ```
 

package/docs/README.md

@@ -4,9 +4,7 @@
 
 # @wtasnorg/node-lib
 
-A library project for nodejs.
-
-#typescript #library
+A library project for nodejs. #nodejs #typescript #library
 
 - [npm org](https://www.npmjs.com/org/wtasnorg)
 - [github repo](https://github.com/wtasg/node-lib)
@@ -32,7 +30,7 @@ npm install @wtasnorg/node-lib
 # check if you can run code
 import {hello} from "@wtasnorg/node-lib";
 
-hello(); 
+await hello(); 
 // "hello from @wtasnorg/node-lib"
 ```
 

package/docs/docs.json

@@ -16,7 +16,8 @@
 				{
 					"fileName": "hello.ts",
 					"line": 6,
-					"character": 9
+					"character": 15,
+					"url": "https://github.com/wtasg/node-lib/blob/8c33d6e85b13c11164c0ab9dca01c58d3cd86813/src/hello.ts#L6"
 				}
 			],
 			"signatures": [
@@ -49,12 +50,25 @@
 						{
 							"fileName": "hello.ts",
 							"line": 6,
-							"character": 9
+							"character": 15,
+							"url": "https://github.com/wtasg/node-lib/blob/8c33d6e85b13c11164c0ab9dca01c58d3cd86813/src/hello.ts#L6"
 						}
 					],
 					"type": {
-						"type": "intrinsic",
-						"name": "string"
+						"type": "reference",
+						"target": {
+							"packageName": "typescript",
+							"packagePath": "lib/lib.es5.d.ts",
+							"qualifiedName": "Promise"
+						},
+						"typeArguments": [
+							{
+								"type": "intrinsic",
+								"name": "string"
+							}
+						],
+						"name": "Promise",
+						"package": "typescript"
 					}
 				}
 			]
@@ -72,7 +86,7 @@
 	"readme": [
 		{
 			"kind": "text",
-			"text": "# @wtasnorg/node-lib\n\nA library project for nodejs.\n\n#typescript #library\n\n- [npm org](https://www.npmjs.com/org/wtasnorg)\n- [github repo](https://github.com/wtasg/node-lib)\n\n## Develop\n\n"
+			"text": "# @wtasnorg/node-lib\n\nA library project for nodejs. #nodejs #typescript #library\n\n- [npm org](https://www.npmjs.com/org/wtasnorg)\n- [github repo](https://github.com/wtasg/node-lib)\n\n## Develop\n\n"
 		},
 		{
 			"kind": "code",
@@ -100,7 +114,7 @@
 		},
 		{
 			"kind": "code",
-			"text": "```typescript\n# check if you can run code\nimport {hello} from \"@wtasnorg/node-lib\";\n\nhello(); \n// \"hello from @wtasnorg/node-lib\"\n```"
+			"text": "```typescript\n# check if you can run code\nimport {hello} from \"@wtasnorg/node-lib\";\n\nawait hello(); \n// \"hello from @wtasnorg/node-lib\"\n```"
 		},
 		{
 			"kind": "text",

package/docs/functions/hello.md

@@ -6,14 +6,14 @@
 
 # Function: hello()
 
-> **hello**(): `string`
+> **hello**(): `Promise`\<`string`\>
 
-Defined in: hello.ts:6
+Defined in: [hello.ts:6](https://github.com/wtasg/node-lib/blob/8c33d6e85b13c11164c0ab9dca01c58d3cd86813/src/hello.ts#L6)
 
 A sample function that should work to test if lib is installed correctly.
 
 ## Returns
 
-`string`
+`Promise`\<`string`\>
 
 hello message

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@wtasnorg/node-lib",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "node library",
+  "main": "src/index.js",
   "scripts": {
     "build": "./node_modules/.bin/tsc --project tsconfig.json",
     "docs": "./node_modules/.bin/typedoc",

package/src/hello.d.ts

@@ -3,6 +3,6 @@
  *
  * @returns hello message
  */
-declare function hello(): string;
+declare function hello(): Promise<string>;
 export { hello };
 //# sourceMappingURL=hello.d.ts.map

package/src/hello.js

@@ -3,7 +3,7 @@
  *
  * @returns hello message
  */
-function hello() {
+async function hello() {
     const message = "hello from @wtasnorg/node-lib";
     if (console?.log) {
         console.log(message);

package/src/hello.test.js

@@ -2,14 +2,14 @@ import { describe, it } from "node:test";
 import { strictEqual } from "node:assert";
 import { hello } from "./hello.js";
 describe("hello", () => {
-    it("returns a string that has the word 'hello' in it", () => {
+    it("returns a string that has the word 'hello' in it", async () => {
         const expected = true;
-        const actual = hello();
+        const actual = await hello();
         strictEqual(actual.includes("hello"), expected);
     });
-    it("returns exact string", () => {
+    it("returns exact string", async () => {
         const expected = "hello from @wtasnorg/node-lib";
-        const actual = hello();
+        const actual = await hello();
         strictEqual(actual, expected);
     });
 });

package/src/hello.test.ts

@@ -3,15 +3,15 @@ import { strictEqual } from "node:assert";
 import { hello } from "./hello.js";
 
 describe("hello", () => {
-    it("returns a string that has the word 'hello' in it", () => {
+    it("returns a string that has the word 'hello' in it", async () => {
         const expected = true;
-        const actual = hello();
+        const actual = await hello();
         strictEqual(actual.includes("hello"), expected);
     });
 
-    it("returns exact string", () => {
+    it("returns exact string", async () => {
         const expected = "hello from @wtasnorg/node-lib";
-        const actual = hello();
+        const actual = await hello();
         strictEqual(actual, expected);
     });
 });

package/src/hello.ts

@@ -3,7 +3,7 @@
  *
  * @returns hello message
  */
-function hello() {
+async function hello() {
     const message = "hello from @wtasnorg/node-lib";
     if (console?.log) {
         console.log(message);