Skip to content

Gun-Vue docs v0.25.1


Gun-Vue docs / user/useUser / useUser

Function: useUser() ​

useUser(): object

Defined in: src/user/useUser.js:50

Returns ​

object

auth() ​

auth: (pair, cb) => Promise<void>

Parameters ​

pair ​

any

cb ​

(pair) => void

Returns ​

Promise<void>

leave() ​

leave: () => void

Returns ​

void

user ​

user: object

user.auth ​

auth: boolean = false

blink: boolean = false

user.color ​

color: string

user.db ​

db: any = undefined

user.initiated ​

initiated: boolean = false

user.is ​

is: any = null

user.name ​

name: string = ""

user.pub ​

pub: any

user.pulse ​

pulse: number = 0

user.pulser ​

pulser: any = null

user.rooms ​

rooms: object = {}

user.safe ​

safe: object

user.safe.enc ​

enc: string = ""

user.safe.pass ​

pass: string = ""

user.safe.password ​

password: string = ""

user.safe.saved ​

saved: boolean = false

user.decrypt() ​

Parameters ​
data ​

any

Returns ​

Promise<any>

user.encrypt() ​

Parameters ​
data ​

any

Returns ​

Promise<any>

user.pair() ​

Returns ​

any

user.secret() ​

Parameters ​
data ​

any

Returns ​

Promise<any>

MIT