mirror of
https://github.com/ZeppelinBot/Zeppelin.git
synced 2025-03-16 14:11:50 +00:00
Add showInDocs property to ZeppelinPluginBlueprint
This commit is contained in:
parent
2c2393d3d4
commit
680a70e464
1 changed files with 7 additions and 3 deletions
|
@ -2,13 +2,17 @@ import { BasePluginType, plugin, PluginBlueprint } from "knub";
|
||||||
import * as t from "io-ts";
|
import * as t from "io-ts";
|
||||||
import { pluginConfigPreprocessor } from "../pluginUtils";
|
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>;
|
configSchema?: t.TypeC<any>;
|
||||||
|
showInDocs?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function zeppelinPlugin(name: string, blueprint: Omit<ZeppelinPluginBlueprint, "name">): ZeppelinPluginBlueprint;
|
export function zeppelinPlugin(name: string, blueprint: Omit<ZeppelinPluginBlueprint, "name">): ZeppelinPluginBlueprint;
|
||||||
export function zeppelinPlugin<TPluginType extends BasePluginType>():
|
export function zeppelinPlugin<TPluginType extends BasePluginType>(): (
|
||||||
(name: string, blueprint: Omit<ZeppelinPluginBlueprint<TPluginType>, "name">) => ZeppelinPluginBlueprint<TPluginType>;
|
name: string,
|
||||||
|
blueprint: Omit<ZeppelinPluginBlueprint<TPluginType>, "name">,
|
||||||
|
) => ZeppelinPluginBlueprint<TPluginType>;
|
||||||
export function zeppelinPlugin(...args) {
|
export function zeppelinPlugin(...args) {
|
||||||
if (args.length) {
|
if (args.length) {
|
||||||
const blueprint: ZeppelinPluginBlueprint = plugin(...(args as Parameters<typeof plugin>));
|
const blueprint: ZeppelinPluginBlueprint = plugin(...(args as Parameters<typeof plugin>));
|
||||||
|
|
Loading…
Add table
Reference in a new issue