Gun-Vue docs v0.25.1

---

Gun-Vue docs / room/useRoom / useRoom

Function: useRoom()

useRoom(pub): object

Defined in: src/room/useRoom.js:53

Parameters

pub

any = currentRoom.pub

Returns

object

createRoom()

createRoom: (__namedParameters) => Promise<void>

Parameters

__namedParameters

featureList?

string[] = ...

name

any

pair

any

publish?

boolean = true

Returns

Promise<void>

enterRoom()

enterRoom: (pub) => void

Parameters

pub

any

Returns

void

leaveRoom()

leaveRoom: () => void

Returns

void

room

room: object

room.features

features: object = {}

room.hosts

hosts: object = {}

room.isFavourite

isFavourite: boolean = false

room.isRoot

isRoot: boolean

room.profile

profile: object = {}

room.pub

pub: any = pub

submitRoom()

submitRoom: (pub) => Promise<void>

Parameters

pub

any

Returns

Promise<void>

updateRoomProfile()

updateRoomProfile: (field, content) => void

Parameters

field

any

content

any

Returns

void