bloxd.io.d.ts 2.0.1 → 2.2.0

package/dist/type/shop/ShopItem.d.ts

@@ -1,25 +1,25 @@
-import { ShopItemBadgeType, ShopItemUserInput } from ".";
-import { CustomTextStyling, StringColor } from "..";
-export type ShopItem = {
-    image: string;
-    cost?: number;
-    currency?: string;
-    amount?: number;
-    imageColour?: StringColor;
-    canBuy?: boolean;
-    isSelected?: boolean;
-    buyButtonText?: string | CustomTextStyling;
-    customTitle?: string | CustomTextStyling;
-    description?: string | CustomTextStyling;
-    onBoughtMessage?: string | CustomTextStyling;
-    redDot?: boolean;
-    forceRemoveRedDot?: boolean;
-    badge?: {
-        text: string | CustomTextStyling;
-        type: ShopItemBadgeType;
-    };
-    userInput?: ShopItemUserInput;
-    sell?: boolean;
-    sortPriority?: number;
-    hidden?: boolean;
-};
+import { ShopItemBadgeType, ShopItemUserInput } from "../index";
+import { CustomTextStyling, StringColor } from "../index";
+export type ShopItem = {
+    image: string;
+    cost?: number;
+    currency?: string;
+    amount?: number;
+    imageColour?: StringColor;
+    canBuy?: boolean;
+    isSelected?: boolean;
+    buyButtonText?: string | CustomTextStyling;
+    customTitle?: string | CustomTextStyling;
+    description?: string | CustomTextStyling;
+    onBoughtMessage?: string | CustomTextStyling;
+    redDot?: boolean;
+    forceRemoveRedDot?: boolean;
+    badge?: {
+        text: string | CustomTextStyling;
+        type: ShopItemBadgeType;
+    };
+    userInput?: ShopItemUserInput;
+    sell?: boolean;
+    sortPriority?: number;
+    hidden?: boolean;
+};

package/dist/type/shop/ShopItemBadgeType.d.ts

@@ -1 +1 @@
-export type ShopItemBadgeType = "new" | "lucky";
+export type ShopItemBadgeType = "new" | "lucky";

package/dist/type/shop/ShopItemKey.d.ts

@@ -1 +1 @@
-export type ShopItemKey = string;
+export type ShopItemKey = string;

package/dist/type/shop/ShopItemUserInput.d.ts

@@ -1,25 +1,25 @@
-import { PlayerId } from "..";
-export type ShopItemUserInput = {
-    type: "text";
-    placeholderText?: string;
-    wordCharsOnly?: boolean;
-    initialValue?: string;
-} | {
-    type: "number";
-    placeholderText?: string;
-    initialValue?: string;
-} | {
-    type: "dropdown";
-    dropdownOptions: readonly (string | {
-        option: string;
-        cost: number;
-    })[];
-    shouldResetSelectionOnOptionsChange?: boolean;
-    initialValue?: string;
-} | {
-    type: "player";
-    excludedPlayers?: PlayerId[];
-} | {
-    type: "color";
-    initialValue?: string;
-};
+import { PlayerId } from "../index";
+export type ShopItemUserInput = {
+    type: "text";
+    placeholderText?: string;
+    wordCharsOnly?: boolean;
+    initialValue?: string;
+} | {
+    type: "number";
+    placeholderText?: string;
+    initialValue?: string;
+} | {
+    type: "dropdown";
+    dropdownOptions: readonly (string | {
+        option: string;
+        cost: number;
+    })[];
+    shouldResetSelectionOnOptionsChange?: boolean;
+    initialValue?: string;
+} | {
+    type: "player";
+    excludedPlayers?: PlayerId[];
+} | {
+    type: "color";
+    initialValue?: string;
+};

package/dist/type/shop/index.d.ts

@@ -1,6 +1,6 @@
-export * from "./ShopCategoryKey";
-export * from "./ShopItem";
-export * from "./ShopItemKey";
-export * from "./ShopItemUserInput";
-export * from "./ShopItemBadgeType";
-export * from "./ShopCategoryConfig";
+export * from "./ShopCategoryKey";
+export * from "./ShopItem";
+export * from "./ShopItemKey";
+export * from "./ShopItemUserInput";
+export * from "./ShopItemBadgeType";
+export * from "./ShopCategoryConfig";

package/dist/type/sound/AllSoundName.d.ts

@@ -1 +1 @@
-export type AllSoundName = "bow" | "cannonFire1";
+export type AllSoundName = "bow" | "cannonFire1";

package/dist/type/sound/SoundName.d.ts

@@ -1,6 +1,2 @@
-import { AllSoundName } from "./AllSoundName";
-declare const SoundNameSymbol: unique symbol;
-export type SoundName = AllSoundName & {
-    readonly [SoundNameSymbol]: unknown;
-};
-export {};
+import { AllSoundName } from "./AllSoundName";
+export type SoundName = AllSoundName;

package/dist/type/sound/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./AllSoundName";
-export * from "./SoundName";
+export * from "./AllSoundName";
+export * from "./SoundName";

package/dist/type/utilType.d.ts

@@ -1,3 +1,3 @@
-export type MargeObject<T> = {
-    [K in keyof T]: T[K];
-};
+export type MargeObject<T> = {
+    [K in keyof T]: T[K];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bloxd.io.d.ts",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "yo",
   "main": "",
   "types": "dist/index.d.ts",

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
+```