jazz-browser
Context Creation
createJazzBrowserContext<Acc>(options):
Promise<BrowserContext<Acc>>
options: BrowserContextOptions<Acc>
createJazzBrowserContext(options):
Promise<BrowserGuestContext>
options: BaseBrowserContextOptions
createJazzBrowserContext<Acc>(options):
Promise<BrowserGuestContext | BrowserContext<Acc>>
options: BrowserContextOptions<Acc> | BaseBrowserContextOptions
type BrowserContext
type BrowserContext<Acc extends Account> = { me: Acc, logOut: () => void, done: () => void }
⚠️ undocumented
Auth Providers
type SessionProvider
type SessionProviderundefined = (accountID: AgentID | ID<Account>) => Promise<SessionID>
⚠️ undocumented
BrowserDemoAuth
BrowserPasskeyAuth
BrowserPassphraseAuth
Invite Links
createInviteLink<C>(value, role, { baseURL?, valueHint? }):
string
value: C,
role: "admin" | "writer" | "reader",
{ baseURL: string, valueHint: string }
parseInviteLink<C>(inviteURL):
{ valueID: ID<C>, inviteSecret: InviteSecret, valueHint: string } | undefined
inviteURL: string
consumeInviteLinkFromWindowLocation<V>({ as, invitedObjectSchema, forValueHint? }):
Promise<{ valueID: ID<V>, inviteSecret: InviteSecret, valueHint: string } | undefined>
{ as: Account, invitedObjectSchema: CoValueClass<V>, forValueHint: string }
Other
provideBroswerLockSession(accountID, crypto):
Promise<{ sessionID: TODO type templateLiteral | TODO type templateLiteral, sessionDone: () => void }>
accountID: ID<Account> | TODO type templateLiteral,
crypto: CryptoProvider<any>
type BrowserGuestContext
type BrowserGuestContextundefined = { guest: AnonymousJazzAgent, logOut: () => void, done: () => void }
⚠️ undocumented
type BrowserContextOptions
type BrowserContextOptions<Acc extends Account> = { auth: AuthMethod, AccountSchema: CoValueClass<Acc> & { fromNode: Account["fromNode"] } } & BaseBrowserContextOptions
⚠️ undocumented
type BaseBrowserContextOptions
type BaseBrowserContextOptionsundefined = { peer: TODO type templateLiteral | TODO type templateLiteral, reconnectionTimeout: number, storage: "singleTabOPFS" | "indexedDB", crypto: CryptoProvider }
⚠️ undocumented