Interface ForkOptions

interface ForkOptions {
    name: string;
    provider?: ProviderKind;
    roomId?: string;
    serverUrl?: string;
    token?: string;
    user?: UserIdentity;
    WebSocketPolyfill?: unknown;
}

Index

Properties

name provider? roomId? serverUrl? token? user? WebSocketPolyfill?

Properties

name

name: string

Branch name; stored in branch's meta for UI.

`Optional`provider

provider?: ProviderKind

Provider for the branch (default: parent's provider).

`Optional`roomId

roomId?: string

New room id for the branch. Defaults to <parent.roomId>/branches/<name>.

`Optional`serverUrl

serverUrl?: string

Forwarded to the new session.

`Optional`token

token?: string

`Optional`user

user?: UserIdentity

Override the user identity on the branch session. Defaults to parent's.

`Optional`WebSocketPolyfill

WebSocketPolyfill?: unknown