Interface UseUserListReturn<User>

UseUserListReturn

Description

interface for user list hook return value

Type Parameters

User extends UserStruct

Hierarchy

UseUserListReturn

Index

Properties

deleteUser error loading next refresh refreshing upsertUser users

Properties

deleteUser

deleteUser: ((userId) => void)

Type declaration

- (userId): void
- Delete user from list
  Parameters
  - userId: User["userId"]
  Returns void

error

error: unknown

Error state

loading

loading: boolean

Loading state, only available on first render

next

next: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Fetch next users to state
  
  Returns Promise<void>

refresh

refresh: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Refresh, clear and reload messages from latest
  
  Returns Promise<void>

refreshing

refreshing: boolean

Refreshing state, status is changes when the refresh is called.

upsertUser

upsertUser: ((user) => void)

Type declaration

- (user): void
- Update or Insert user to list
  Parameters
  - user: User
  Returns void

users

users: User[]

Get users state

Generated using TypeDoc