Module: apollo/profile

Interfaces

• EditorState

Type aliases

EditorAction

Ƭ EditorAction<T>: { type: "discard" | "save" | "unsave" } | { original: T ; type: "original" } | { top: Partial<T> ; type: "top" } | { doc: Partial<T["doc"]> ; type: "doc" } | { online: number ; type: "online" }

Type parameters

Name	Type
T	extends Object

Variables

UpdateProfileMutation

• UpdateProfileMutation: DocumentNode

---

userFields

• userFields: string[]

Functions

profileEditorReducer

▸ profileEditorReducer<T>(prev, action): Object

Type parameters

Name	Type
T	extends Object

Parameters

Name	Type
prev	EditorState<T>
action	EditorAction<T>

Returns

Object

Name	Type
data	any
doc	Object
original	any
ref	Object
ref.latest	number
ref.online	number
saving	boolean
top	Object
version	number

---

useProfile

▸ useProfile(): Profile

Returns

Profile

---

useProfileEditor

▸ useProfileEditor(__namedParameters?): Object

Parameters

Name	Type
__namedParameters	Object
__namedParameters.debounce	undefined | number

Returns

Object

Name	Type
dispatch	Dispatch<EditorAction<Profile>>
profile	Profile
submit	() => Promise<void>
updateDoc	(doc: Partial<UserDoc>) => void
updateProfile	(top: Partial<Profile>) => void

---

useProfileQuery

▸ useProfileQuery(): QueryResult<{ users_by_pk: Profile }, { uid: string }>

todo set timezone on first use

Returns

QueryResult<{ users_by_pk: Profile }, { uid: string }>

---

useProfileSubscription

▸ useProfileSubscription(): Object

todo set timezone on first use

Returns

Object

Name	Type
data?	Object
data.users_by_pk	Profile
error?	ApolloError
loading	boolean
variables	undefined | { uid: string }

---

useProfileUpdate

▸ useProfileUpdate(): Object

Immediately apply profile updates

Returns

Object

Name	Type
updateDoc	(doc: Partial<UserDoc>) => Promise<void>
updateProfile	(top: Partial<Profile>) => Promise<void>