SessionHandler

import { SessionHandler } from "dreamkit";

Handles the session params using her the constructor created with $session.

---

Definition

abstract class SessionHandler {
  get(constructor: object): Promise<unknown | undefined>;
  unset(constructor: object): Promise<void>;
  set(constructor: object, value: unknown | null | undefined): Promise<void>;
  protected abstract onGet(constructor: object): Promise<any>;
  protected abstract onSet(
    constructor: object,
    params: any,
  ): Promise<unknown>;
}

get

Gets the session params if they exist, otherwise an undefined value.

unset

Deletes the session params.

set

Sets and saves the session params. If the params are invalid it will throw an error.

---

Examples

Caution

Playground doesn’t work because StackBlitz doesn’t support Node.js 20.

Download the examples to run them.

Basic usage

import {
  $api,
  $route,
  $session,
  createAction,
  Input,
  s,
  SessionHandler,
} from "dreamkit";
import { createResource, createSignal } from "solid-js";

class ClientSession extends $session
  .name("client")
  .params({ locale: s.title("Locale").string() })
  .create() {}

const set = $api
  .title("Set")
  .params(ClientSession.params)
  .self({ SessionHandler })
  .create(async function (params) {
    await this.sessionHandler.set(ClientSession, params);
  });

const unset = $api
  .title("Unset")
  .self({ SessionHandler })
  .create(async function () {
    await this.sessionHandler.unset(ClientSession);
  });

const get = $api
  .title("Get")
  .self({ SessionHandler })
  .create(async function () {
    return await this.sessionHandler.get(ClientSession);
  });

export default $route
  .api({ set, unset, get })
  .path("/")
  .create(({ api }) => {
    const [locale, setLocale] = createSignal("");
    const set = createAction(api.set).with(() => ({ locale: locale() }));
    const unset = createAction(api.unset);
    const [get, { refetch }] = createResource(api.get);
    return (
      <>
        <Input
          placeholder={set.params.locale.options.title}
          value={locale}
          onChange={setLocale}
        />
        <p>
          <button onClick={set} disabled={set.running} children={set.title} />
          <button
            onClick={unset}
            disabled={unset.running}
            children={unset.title}
          />
          <button
            onClick={refetch}
            disabled={get.loading}
            children={
              <>
                {api.get.title}: {JSON.stringify(get.latest)}
              </>
            }
          />
        </p>
      </>
    );
  });