[]
ナレッジベース デモ ヘルプ APIリファレンス デザイナ
トライアル版
(Showing Draft Content)

Server

クラス: Server

双方向通信、ミドルウェア、フックメカニズムを提供する共同編集サーバーを表します。

Table of contents

コンストラクタ

プロパティ

メソッド

コンストラクタ

constructor

• new Server(config?)

パラメータ

名前 型
config? IServerConfig

プロパティ

licenseKey

• licenseKey: string

サーバー検証および共同編集機能のためのライセンスキー。

メソッド

on

▸ on(hooks): void

サーバーへの複数のフックをバッチで登録します。

パラメータ

名前 型 説明
hooks IHooks 登録するフック。

戻り値

void

▸ on<K>(action, hook): void

サーバー上の特定のアクションに対して1つのフックを登録します。

Type parameters

名前 型 説明
K IHookContextのキーを拡張します。 アクション名のタイプ。IHookContextのキーを拡張したもの。

パラメータ

名前 型 説明
action K フックに関連付けるアクションの名前。
hook IHook<IHookContext[K]> 指定したアクションを登録するフック。

戻り値

void

use

▸ use(middlewares): void

複数のミドルウェアをバッチでサーバへ登録します。

パラメータ

名前 型 説明
middlewares IMiddlewares 登録するミドルウェア。

戻り値

void

▸ use<K>(action, middleware): void

サーバー上の特定のアクションに対して単一のミドルウェアを登録します。

Type parameters

名前 型 説明
K IMiddlewareContextのキーを拡張します。 アクション名のタイプ。IMiddlewareContextのキーを拡張したもの。

パラメータ

名前 型 説明
action K ミドルウェアに関連付けるアクションの名前。。
middleware IMiddleware<IMiddlewareContext[K]> 指定したアクションを登録するミドルウェア。

戻り値

void

useFeature

▸ useFeature(feature): void

機能をサーバーに登録します。。

パラメータ

名前 型 説明
feature IFeature 登録する機能。

戻り値

void