Interface BackendSession

What a backend tells the core about the session it serves.

interface BackendSession {
    cwd_load(): Promise<string | null>;
    cwd_save(path: string): Promise<void>;
    home_get(): Promise<string>;
    identity_get(): Promise<SessionIdentity>;
    init(): Promise<void>;
    user_get(): Promise<string | null>;
}

Index

Methods

cwd_load cwd_save home_get identity_get init user_get

Methods

cwd_load

cwd_load(): Promise<string | null>
The working directory the identity left, or null when it has none stored.

Returns Promise<string | null>
- Defined in packages/brasa/src/core/backend.ts:49

cwd_save

cwd_save(path: string): Promise<void>
Stores the working directory for the identity.
Parameters
- path: string
Returns Promise<void>
- Defined in packages/brasa/src/core/backend.ts:51

home_get

home_get(): Promise<string>
The session's home: where it begins before it has a working directory of its own.

Returns Promise<string>
- Defined in packages/brasa/src/core/backend.ts:47

identity_get

identity_get(): Promise<SessionIdentity>
Who the session is, connected or not.

Returns Promise<SessionIdentity>
- Defined in packages/brasa/src/core/backend.ts:43

init

init(): Promise<void>
Prepares the backend's own state (configuration, stored credentials) before the session starts.

Returns Promise<void>
- Defined in packages/brasa/src/core/backend.ts:41

user_get

user_get(): Promise<string | null>
The session's user as the backend last knew them, or null when it knows none.

Returns Promise<string | null>
- Defined in packages/brasa/src/core/backend.ts:45