Add showInDocs property to ZeppelinPluginBlueprint

This commit is contained in:
Dragory 2020-07-06 02:01:01 +03:00
parent 2c2393d3d4
commit 680a70e464
No known key found for this signature in database
GPG key ID: 5F387BA66DF8AAC1

View file

@ -2,13 +2,17 @@ import { BasePluginType, plugin, PluginBlueprint } from "knub";
import * as t from "io-ts";
import { pluginConfigPreprocessor } from "../pluginUtils";
export interface ZeppelinPluginBlueprint<TPluginType extends BasePluginType = BasePluginType> extends PluginBlueprint<TPluginType> {
export interface ZeppelinPluginBlueprint<TPluginType extends BasePluginType = BasePluginType>
extends PluginBlueprint<TPluginType> {
configSchema?: t.TypeC<any>;
showInDocs?: boolean;
}
export function zeppelinPlugin(name: string, blueprint: Omit<ZeppelinPluginBlueprint, "name">): ZeppelinPluginBlueprint;
export function zeppelinPlugin<TPluginType extends BasePluginType>():
(name: string, blueprint: Omit<ZeppelinPluginBlueprint<TPluginType>, "name">) => ZeppelinPluginBlueprint<TPluginType>;
export function zeppelinPlugin<TPluginType extends BasePluginType>(): (
name: string,
blueprint: Omit<ZeppelinPluginBlueprint<TPluginType>, "name">,
) => ZeppelinPluginBlueprint<TPluginType>;
export function zeppelinPlugin(...args) {
if (args.length) {
const blueprint: ZeppelinPluginBlueprint = plugin(...(args as Parameters<typeof plugin>));