use-upbit-api - npm Package Compare versions

Comparing version 1.1.3 to 1.1.4

lib/index.d.ts

@@ -1,2 +0,2 @@
-interface ImarketCodes {
+export interface ImarketCodes {
     market: string;
@@ -6,3 +6,90 @@ korean_name: string;
 }
-export declare function useUpbitWebSocket(targetMarketCodes?: ImarketCodes[], type?: string, options?: {
+export declare type RequestType = "ticker" | "orderbook" | "trade";
+export declare type ChangeType = "RISE" | "EVEN" | "FALL";
+export declare type OrderType = "ASK" | "BID";
+export declare type MarketStateType = "PREVIEW" | "ACTIVE" | "DELISTED";
+export declare type MarketWarningType = "NONE" | "CAUTION";
+export declare type StreamType = "SNAPSHOT" | "REALTIME";
+export interface ITicker {
+    type: RequestType;
+    code: string;
+    opening_price: number;
+    high_price: number;
+    low_price: number;
+    trade_price: number;
+    prev_closing_price: number;
+    acc_trade_price: number;
+    change: ChangeType;
+    change_price: number;
+    signed_change_price: number;
+    change_rate: number;
+    signed_change_rate: number;
+    ask_bid: OrderType;
+    trade_volume: number;
+    acc_trade_volume: number;
+    trade_date: string;
+    trade_time: string;
+    trade_timestamp: number;
+    acc_ask_volume: number;
+    acc_bid_volume: number;
+    highest_52_week_price: number;
+    highest_52_week_date: string;
+    lowest_52_week_price: number;
+    lowest_52_week_date: string;
+    market_state: MarketStateType;
+    is_trading_suspended: false;
+    delisting_date?: Date;
+    market_warning: MarketWarningType;
+    timestamp: number;
+    acc_trade_price_24h: number;
+    acc_trade_volume_24h: number;
+    stream_type: StreamType;
+}
+export interface IOrderbookUnit {
+    ask_price: number;
+    bid_price: number;
+    ask_size: number;
+    bid_size: number;
+}
+export interface IOrderbook {
+    type: RequestType;
+    code: string;
+    timestamp: number;
+    total_ask_size: number;
+    total_bid_size: number;
+    orderbook_units: IOrderbookUnit[];
+    stream_type: StreamType;
+}
+export interface ITrade {
+    type: RequestType;
+    code: string;
+    timestamp: number;
+    trade_date: string;
+    trade_time: string;
+    trade_timestamp: number;
+    trade_price: number;
+    trade_volume: number;
+    ask_bid: OrderType;
+    prev_closing_price: number;
+    change: ChangeType;
+    change_price: number;
+    sequential_id: number;
+    stream_type: StreamType;
+}
+export interface TickerInterface {
+    socket: WebSocket | null;
+    isConnected: boolean;
+    socketData: ITicker[];
+}
+export interface OrderbookInterface {
+    socket: WebSocket | null;
+    isConnected: boolean;
+    socketData: IOrderbook;
+}
+export interface TradeInterface {
+    socket: WebSocket | null;
+    isConnected: boolean;
+    socketData: ITrade[];
+}
+export declare function useUpbitWebSocket(targetMarketCodes?: ImarketCodes[], type?: RequestType, options?: {
     throttle_time: number;
@@ -19,2 +106,1 @@ max_length_queue: number;
 };
-export {};

package.json

 {
   "name": "use-upbit-api",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "This is React Custom Hook for upbit api",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -1,2 +0,2 @@
-# use-upbit-api v1.1.3
+# use-upbit-api v1.1.4
 
@@ -261,2 +261,37 @@ **The use-upbit-api custom hook for Upbit API** (Korea crypto exchange). In the previous, Upbit API's Websocket usage in React is difficult for developer who is unfamiliar with websocket in React, but this React Custom Hook solve the problem. Let's use this awesome custom hooks!
 
+## typescript Support
+
+**ticker API**
+
+```tsx
+import { TickerInterface, useUpbitWebSocket } from "use-upbit-api";
+
+const { socket, isConnected, socketData }: TickerInterface = useUpbitWebSocket(
+  targetMarketCodes,
+  "ticker",
+  option
+);
+```
+
+**orderbook API**
+
+```tsx
+import { OrderbookInterface, useUpbitWebSocket } from "use-upbit-api";
+
+const { socket, isConnected, socketData }: OrderbookInterface =
+  useUpbitWebSocket(targetMarketCodes, "orderbook", option);
+```
+
+**trade API**
+
+```tsx
+import { TradeInterface, useUpbitWebSocket } from "use-upbit-api";
+
+const { socket, isConnected, socketData }: TradeInterface = useUpbitWebSocket(
+  targetMarketCodes,
+  "trade",
+  option
+);
+```
+
 ## Contributing
@@ -263,0 +298,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

27634

increased by13.28%

Lines of code

415

increased by26.14%

Number of lines in readme file

303

increased by13.06%

No dependency changes