minca
ApiCoreFunctions

Function: createHostNode()

function createHostNode(config): Promise<Readonly<{
  did: string;
  evaluate: () => Promise<Changes>;
  fullUntil: (subscription) => 
     | {
     since: number;
     until: number;
   }
    | null;
  get: (id) => Promise<Subscription | null>;
  heldBack: (spaceId) => boolean;
  limits: HostLimits | null;
  linksAt: (topic) => readonly string[];
  list: () => Promise<Subscription[]>;
  outOfRoom: (subscription) => boolean;
  paysItself: (spaceId) => Promise<boolean>;
  plan: (subscription) => "paid" | "free" | null;
  recheck: () => Promise<void>;
  spaces: () => Promise<readonly CarriedSpace[]>;
  state: (subscription) => SubscriptionState;
  subscribe: (id) => Promise<Subscription>;
  subscribeEvents: (listener) => () => void;
  attach(id, account, invite): Promise<Subscription>;
  authenticator(spaceId): Promise<ServerAuth | null>;
  carriedFor(id): Promise<number>;
  carrySpace(id, pass): Promise<Subscription>;
  close(): Promise<void>;
  detach(id): Promise<void>;
  extend(id, until, customer?): Promise<Subscription>;
  holdForRoom(id, spaceIds): Promise<void>;
  namedFor(id): Promise<readonly string[]>;
  overFor(id): Promise<readonly OverSpace[]>;
  read(spaceId, session): void;
  readKeyOf(id): string | null;
  refuse(id): Promise<void>;
  seen(id): Promise<void>;
  setFull(id, over): Promise<void>;
  setInvoice(id, invoice): Promise<Subscription>;
  setPaidUntil(id, until): Promise<Subscription>;
  spacesOf(id): Promise<readonly string[]>;
  sweep(): Promise<readonly string[]>;
  usage(spaceId): Promise<SpaceUsage | null>;
}>>;

Defined in: packages/core/src/node/host.ts:170

Starts a host

Parameters

ParameterType
configHostConfig

Returns

Promise<Readonly<{ did: string; evaluate: () => Promise<Changes>; fullUntil: (subscription) => | { since: number; until: number; } | null; get: (id) => Promise<Subscription | null>; heldBack: (spaceId) => boolean; limits: HostLimits | null; linksAt: (topic) => readonly string[]; list: () => Promise<Subscription[]>; outOfRoom: (subscription) => boolean; paysItself: (spaceId) => Promise<boolean>; plan: (subscription) => "paid" | "free" | null; recheck: () => Promise<void>; spaces: () => Promise<readonly CarriedSpace[]>; state: (subscription) => SubscriptionState; subscribe: (id) => Promise<Subscription>; subscribeEvents: (listener) => () => void; attach(id, account, invite): Promise<Subscription>; authenticator(spaceId): Promise<ServerAuth | null>; carriedFor(id): Promise<number>; carrySpace(id, pass): Promise<Subscription>; close(): Promise<void>; detach(id): Promise<void>; extend(id, until, customer?): Promise<Subscription>; holdForRoom(id, spaceIds): Promise<void>; namedFor(id): Promise<readonly string[]>; overFor(id): Promise<readonly OverSpace[]>; read(spaceId, session): void; readKeyOf(id): string | null; refuse(id): Promise<void>; seen(id): Promise<void>; setFull(id, over): Promise<void>; setInvoice(id, invoice): Promise<Subscription>; setPaidUntil(id, until): Promise<Subscription>; spacesOf(id): Promise<readonly string[]>; sweep(): Promise<readonly string[]>; usage(spaceId): Promise<SpaceUsage | null>; }>>

On this page