Browser-toolkit | 루비콘 라이브러리 문서

Index

Type aliases

WithoutRequestBodyOptions

WithoutRequestBodyOptions: Omit<RequestOptions, "body">

Functions

clearLocalStorage

clearLocalStorage(): void

- Defined in browser-toolkit/src/localStorage/index.ts:84
로컬스토리지 내의 모든 데이터를 제거합니다.

Returns void

Const copyToClipboard

copyToClipboard(text: string): Promise<boolean>

인자로 받은 텍스트를 클립보드에 복사합니다.

example

const result = await copyToClipboard('하이');
if (result) {
  console.log('클립보드에 복사 성공');
} else {
  console.log('클립보드에 복사 실패');
}

Parameters

text: string

Returns Promise<boolean>

createFetchInstance

createFetchInstance(baseUrl: string, options?: RequestOptions): { delete: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; get: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; patch: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; post: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; put: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; request: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>> }

- Defined in browser-toolkit/src/fetch/index.ts:6
Parameters
- baseUrl: string
- Optional options: RequestOptions
Returns { delete: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; get: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; patch: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; post: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; put: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>; request: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>> }
- delete: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>
  - - <T>(path: string, additionalOptions?: RequestOptions): Promise<LubyconSuccessResponse<T>>
    - Type parameters
      - T
      Parameters
      - path: string
      - Optional additionalOptions: RequestOptions
      Returns Promise<LubyconSuccessResponse<T>>
- get: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>
  - - <T>(path: string, additionalOptions?: RequestOptions): Promise<LubyconSuccessResponse<T>>
    - Type parameters
      - T
      Parameters
      - path: string
      - Optional additionalOptions: RequestOptions
      Returns Promise<LubyconSuccessResponse<T>>
- patch: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>
  - - <T>(path: string, data: any, additionalOptions?: RequestOptions): Promise<LubyconSuccessResponse<T>>
    - Type parameters
      - T
      Parameters
      - path: string
      - data: any
      - Optional additionalOptions: RequestOptions
      Returns Promise<LubyconSuccessResponse<T>>
- post: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>
  - - <T>(path: string, data: any, additionalOptions?: RequestOptions): Promise<LubyconSuccessResponse<T>>
    - Type parameters
      - T
      Parameters
      - path: string
      - data: any
      - Optional additionalOptions: RequestOptions
      Returns Promise<LubyconSuccessResponse<T>>
- put: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>
  - - <T>(path: string, data: any, additionalOptions?: RequestOptions): Promise<LubyconSuccessResponse<T>>
    - Type parameters
      - T
      Parameters
      - path: string
      - data: any
      - Optional additionalOptions: RequestOptions
      Returns Promise<LubyconSuccessResponse<T>>
- request: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>
  - - <T>(path: string, additionalOptions?: RequestOptions): Promise<LubyconSuccessResponse<T>>
    - Type parameters
      - T
      Parameters
      - path: string
      - Optional additionalOptions: RequestOptions
      Returns Promise<LubyconSuccessResponse<T>>

createLocalStorageChangeEvent

createLocalStorageChangeEvent<T>(payload: LocalStorageEventPayload<T>): CustomEvent<LocalStorageEventPayload<T>>

- Defined in browser-toolkit/src/localStorage/localStorageEvent.ts:6
Type parameters
- T
Parameters
- payload: LocalStorageEventPayload<T>
Returns CustomEvent<LocalStorageEventPayload<T>>

doDelete

doDelete<T>(url: string, options?: WithoutRequestBodyOptions): Promise<LubyconSuccessResponse<T>>

- Defined in browser-toolkit/src/fetch/index.ts:76
Type parameters
- T
Parameters
- url: string
- Optional options: WithoutRequestBodyOptions
Returns Promise<LubyconSuccessResponse<T>>

doGet

doGet<T>(url: string, options?: WithoutRequestBodyOptions): Promise<LubyconSuccessResponse<T>>

- Defined in browser-toolkit/src/fetch/index.ts:60
Type parameters
- T
Parameters
- url: string
- Optional options: WithoutRequestBodyOptions
Returns Promise<LubyconSuccessResponse<T>>

doPatch

doPatch<T>(url: string, data: any, options?: WithoutRequestBodyOptions): Promise<LubyconSuccessResponse<T>>

- Defined in browser-toolkit/src/fetch/index.ts:68
Type parameters
- T
Parameters
- url: string
- data: any
- Optional options: WithoutRequestBodyOptions
Returns Promise<LubyconSuccessResponse<T>>

doPost

doPost<T>(url: string, data: any, options?: WithoutRequestBodyOptions): Promise<LubyconSuccessResponse<T>>

- Defined in browser-toolkit/src/fetch/index.ts:64
Type parameters
- T
Parameters
- url: string
- data: any
- Optional options: WithoutRequestBodyOptions
Returns Promise<LubyconSuccessResponse<T>>

doPut

doPut<T>(url: string, data: any, options?: WithoutRequestBodyOptions): Promise<LubyconSuccessResponse<T>>

- Defined in browser-toolkit/src/fetch/index.ts:72
Type parameters
- T
Parameters
- url: string
- data: any
- Optional options: WithoutRequestBodyOptions
Returns Promise<LubyconSuccessResponse<T>>

doRequest

doRequest<T>(url: string, options?: RequestOptions): Promise<LubyconSuccessResponse<T>>

모든 요청은 header, status, data를 담은 response를 반환합니다.

example

import { doRequest } from 'browser-toolkit';

const correctFetch = async () => {
 const URL = 'https://pokeapi.co/api/v2/pokemon'
 const response = await doRequest(URL);
};

const wrongFetch = async () => {
 const WRONG_URL = 'https://pokeapi.co/api/v2/pokekemon';
 const response = await doRequest(WRONG_URL);
 console.log(response.data)   // 요청이 실패한 경우 response의 data 프로퍼티는 null을 반환합니다
};

const abortController = new AbortController();
doRequest(URL, { signal: abortController.signal }).then((response) => {
 console.log(response);
});
abortController.abort();   // abort 메서드를 통해 pending 상태인 fetch 요청을 취소시킬 수 있습니다

Type parameters

Parameters

url: string
Optional options: RequestOptions

Returns Promise<LubyconSuccessResponse<T>>

findQueryParamInClient

findQueryParamInClient(key: string): string

- Defined in browser-toolkit/src/querystring/index.ts:16
쿼리스트링의 키를 기반으로 값을 가져옵니다. 만약 값이 존재하지 않을 경우 undefined가 반환됩니다. 쿼리 스트링 맵은 location.search의 값을 인자로 받은 parseQueryString 함수의 결과 값입니다.
example
```
findQueryParamInClient('foo');
// location.search -> '?foo=1&bar=%ED%95%98%EC%9D%B4'
// '1'
// location.search -> '?bar=%ED%95%98%EC%9D%B4'
// undefined
```
Parameters
- key: string
Returns string

getCookie

getCookie<T>(key: string): T | undefined
getCookie<T>(key: string, parser: (v: string) => T): T | undefined

- Defined in browser-toolkit/src/cookies/index.ts:45
인자로 주어진 key에 해당하는 쿠키를 가져옵니다. 만약 해당 쿠키가 존재하지 않는 경우 undefined를 반환합니다.
example
```
const foo = getCookie('foo'); // string | undefined;
const foo = getCookie('foo', Number); // number | undefined;
const foo = getCookie('foo', v => [v]) // string[] | undefined;
```
Type parameters
- T: string
Parameters
- key: string
Returns T | undefined
- Defined in browser-toolkit/src/cookies/index.ts:46
Type parameters
- T
Parameters
- key: string
- parser: (v: string) => T
  - - (v: string): T
    - Parameters
      - v: string
      Returns T
Returns T | undefined

getCookies

getCookies(): Record<string, string>

- Defined in browser-toolkit/src/cookies/index.ts:31
전체 쿠키를 가져옵니다. 만약 쿠키가 없는 경우에는 빈 객체를 반환합니다.
example
```
const { foo } = getCookies();
console.log(foo);
```
Returns Record<string, string>

getLocalStorageItem

getLocalStorageItem<T>(key: string): T | null

- Defined in browser-toolkit/src/localStorage/index.ts:41
로컬스토리지에서 데이터를 가져옵니다. 만약 만료 시간이 지정된 데이터이고, 만료 시간이 지난 상태라면 null이 반환됩니다.

Type parameters
- T
Parameters
- key: string
Returns T | null

Const isClipboardCommandSupported

isClipboardCommandSupported(): boolean

- Defined in browser-toolkit/src/copyToClipboard/index.ts:11
Returns boolean

Const isClipboardSupported

isClipboardSupported(): boolean

- Defined in browser-toolkit/src/copyToClipboard/index.ts:10
Returns boolean

loadScript

loadScript(src: string, options?: Options): Promise<unknown>

- Defined in browser-toolkit/src/loadScript/index.ts:17
비동기적으로 스크립트를 로드하고 실행합니다. 로드가 완료되면 Promise가 resolve됩니다.

함수의 두 번째 인자로 async, defer 속성을 추가할 수도 있으며, 기본 값은 async = true , defer = false입니다.
example
```
await loadScript('https://developers.kakao.com/sdk/js/kakao.js');
window.Kakao.init('my-token');
```
Parameters
- src: string
- options: Options = {}
Returns Promise<unknown>

popLocalStorageItem

popLocalStorageItem<T>(key: string): T | null

- Defined in browser-toolkit/src/localStorage/index.ts:74
로컬스토리지에서 데이터를 가져온 후 해당 데이터를 로컬스토리지에서 제거합니다.

Type parameters
- T
Parameters
- key: string
Returns T | null

removeLocalStorageItem

removeLocalStorageItem(key: string): void

- Defined in browser-toolkit/src/localStorage/index.ts:66
로컬스토리지에서 데이터를 제거합니다.

Parameters
- key: string
Returns void

setCookie

setCookie<T>(key: string, value: T, options?: SetCookieOptions): void

- Defined in browser-toolkit/src/cookies/index.ts:14
쿠키에 값을 세팅합니다. expires, path 등의 쿠키 옵션을 사용할 수 있습니다.
example
```
setCookie('foo', 1);
setCookie('foo', 1, { expires: new Date(2022, 1, 15) });
```
Type parameters
- T: CookieValue
Parameters
- key: string
- value: T
- Optional options: SetCookieOptions
Returns void

setLocalStorageItem

setLocalStorageItem<T>(key: string, data: T, expiryHour?: number): void

- Defined in browser-toolkit/src/localStorage/index.ts:28
로컬스토리지에 데이터를 저장합니다. 3번째 인자 expiryHour로 데이터의 만료 시간을 지정할 수 있습니다.

Type parameters
- T
Parameters
- key: string
- data: T
- Optional expiryHour: number
Returns void

Index

Namespaces

Interfaces

Type aliases

Functions

Type aliases

WithoutRequestBodyOptions

Functions

clearLocalStorage

Returns void

Const copyToClipboard

Parameters

text: string

Returns Promise<boolean>

createFetchInstance

Parameters

baseUrl: string

Optional options: RequestOptions

delete: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>

Type parameters

T

Parameters

path: string

Optional additionalOptions: RequestOptions

Returns Promise<LubyconSuccessResponse<T>>

get: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>

Type parameters

T

Parameters

path: string

Optional additionalOptions: RequestOptions

Returns Promise<LubyconSuccessResponse<T>>

patch: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>

Type parameters

T

Parameters

path: string

data: any

Optional additionalOptions: RequestOptions

Returns Promise<LubyconSuccessResponse<T>>

post: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>

Type parameters

T

Parameters

path: string

data: any

Optional additionalOptions: RequestOptions

Returns Promise<LubyconSuccessResponse<T>>

put: <T>(path: string, data: any, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>

Type parameters

T

Parameters

path: string

data: any

Optional additionalOptions: RequestOptions

Returns Promise<LubyconSuccessResponse<T>>

request: <T>(path: string, additionalOptions?: RequestOptions) => Promise<LubyconSuccessResponse<T>>

Type parameters

T

Parameters

path: string

Optional additionalOptions: RequestOptions

Returns Promise<LubyconSuccessResponse<T>>

createLocalStorageChangeEvent

Type parameters

T

Parameters

payload: LocalStorageEventPayload<T>

Returns CustomEvent<LocalStorageEventPayload<T>>

doDelete

Type parameters

T

Parameters

url: string

Optional options: WithoutRequestBodyOptions

Returns Promise<LubyconSuccessResponse<T>>

doGet

Type parameters

T

Parameters