Framework v2.x

PluginManifest #

Available since 2.8.0
Experimental: non-backward compatible changes or removal may occur in any future release.

The PluginManifest type is used to describe plugin behavior.

This type must be passed to the Plugin constructor.

Copied to clipboard!
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  * Copyright 2015-2020 Kuzzle
  * mailto: support AT
  * website:
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  * PluginManifest
export type PluginManifest = {
    * Semver range representing plugin compatibility with Kuzzle.
    * @example ">=2.8.0 <3"
  kuzzleVersion: string;