bloxd.io.d.ts 2.0.0 → 2.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2026 bulebrainbrand
+
+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
+(including the next paragraph) 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/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "bloxd.io.d.ts",
-  "version": "2.0.0",
-  "description": "yo",
-  "main": "",
-  "types": "dist/index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/bulebrainbrand/bloxd.io.d.ts.git"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "module",
-  "bugs": {
-    "url": "https://github.com/bulebrainbrand/bloxd.io.d.ts/issues"
-  },
-  "homepage": "https://github.com/bulebrainbrand/bloxd.io.d.ts#readme",
-  "files": [
-    "dist/"
-  ],
-  "scripts": {
-    "build": "tsc && tsc-alias"
-  },
-  "devDependencies": {
-    "tsc-alias": "^1.8.16",
-    "typescript": "^6.0.2"
-  }
-}
+{
+  "name": "bloxd.io.d.ts",
+  "version": "2.1.0",
+  "description": "yo",
+  "main": "",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bulebrainbrand/bloxd.io.d.ts.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/bulebrainbrand/bloxd.io.d.ts/issues"
+  },
+  "homepage": "https://github.com/bulebrainbrand/bloxd.io.d.ts#readme",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsc && tsc-alias"
+  },
+  "devDependencies": {
+    "tsc-alias": "^1.8.16",
+    "typescript": "^6.0.2"
+  }
+}

package/readme.md

@@ -1,3 +1,50 @@
 this project is not offical bloxd.io repo.
 
-##
+## how to use
+
+Use `npm i bloxd.io.d.ts -D` in terminal(need node.js)
+
+and add this option in tsconfig.json
+
+```json
+{
+  "compileOptions": {
+    "types": ["bloxd.io.d.ts"]
+  }
+}
+```
+
+## why use this
+
+This package include bloxd.io api docment and d.ts.
+It useful typecheck(as typescript),lint and killing typo(most important).
+
+## how to contribute
+
+- add more api type in src.
+- add more docment.
+- check code.
+- use this package
+
+## repo structure
+
+```
+src/
+  api-type-def/ # api functions type define
+    clientOption/ # clientOption apis define
+      clientOptions/ # clientOption function overload define(by clientOption name)
+      index.ts # marge clientOptions overload
+
+    entitySetting/ # entitySetting define
+      entitySettings/ # entitySetting function overload(by entitySetting name)
+      index.ts # marge entitySetting overload
+    mobSetting/ # making now...
+
+    normal/ # define other apis
+
+    index.ts # marge api
+  type/ # use type define e.g.`PlayerId`
+  index.ts # top level file
+
+dist/ # d.ts result of tsc.npm package install target
+```