Class default

The main WaifuSocket class

Hierarchy

default

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new default(): default

Returns default

Properties

Private rest

rest: Rest

Private socket

socket: Socket

Methods

close

close(): void

- Defined in index.d.ts:69
Closes the websocket.

Returns void

collection

collection(): Promise<RestWaifu[]>

- Defined in index.d.ts:108
Fetches all waifus in your collection

Returns Promise<RestWaifu[]>

fetch

fetch(waifu: string | RestWaifu): Promise<DetailedWaifu>

- Defined in index.d.ts:114
Fetches additional info for a saved waifu

Parameters
- waifu: string | RestWaifu
  
  a waifu or her ID
Returns Promise<DetailedWaifu>

genBig

genBig(waifu: string | SocketWaifu, size?: number): Promise<SocketWaifu>

- Defined in index.d.ts:96
Generates a large image of a waifu

Parameters
- waifu: string | SocketWaifu
  
  a waifu or her seeds
- Optional size: number
  
  currently unused
Returns Promise<SocketWaifu>

genGrid

genGrid(step: 0): Promise<grid>
genGrid(step: 1 | 2 | 3, waifu: string | SocketWaifu): Promise<grid>

- Defined in index.d.ts:79
Generates 16 new waifus

Parameters
- step: 0
  - 0: all attributes
    1: color
    2: details
    3: pose
Returns Promise<grid>
- Defined in index.d.ts:89
Generates 16 new waifus

Parameters
- step: 1 | 2 | 3
  - 0: all attributes
    1: color
    2: details
    3: pose
- waifu: string | SocketWaifu
  
  a waifu or her seeds
Returns Promise<grid>

login

login(cookie?: string): Promise<default>

- Defined in index.d.ts:64
Logs in and connects to the websocket.

Parameters
- Optional cookie: string
  
  your "user_remember_me" cookie on waifulabs.com
Returns Promise<default>

save

save(waifu: string | SocketWaifu, name: string): Promise<RestWaifu & { seeds: string }>

- Defined in index.d.ts:103
Saves a waifu to your collection

Parameters
- waifu: string | SocketWaifu
  
  a waifu or her seeds
- name: string
  
  a cute waifu needs a cute name
Returns Promise<RestWaifu & { seeds: string }>

Generated using TypeDoc