Start9/start-sdk
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-sdk.git synced 2026-03-26 02:11:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #20 from Start9Labs/update/union-optional-desc

Browse Source 
add wrapper type for optional description for unions
This commit is contained in:
J H
2023-01-31 10:57:23 -07:00
committed by GitHub
parent 0963e0dd49 66f12ffa74
commit 9b075040d8
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
types.ts
View File

@@ -190,6 +190,14 @@ export type WithDescription<T> = T & {
warning?: string;
};
export type WithOptionalDescription<T> = T & {
/** @deprecated - optional only for backwards compatibility */
description?: string;
/** @deprecated - optional only for backwards compatibility */
name?: string;
warning?: string;
};
export type ListSpec<T> = {
spec: T;
range: string;
@@ -275,7 +283,7 @@ export type ValueSpecAny =
>
| Tag<"list", ValueSpecList>
| Tag<"object", WithDescription<WithNullableDefault<ValueSpecObject, Config>>>
| Tag<"union", WithDescription<WithDefault<ValueSpecUnion, string>>>
| Tag<"union", WithOptionalDescription<WithDefault<ValueSpecUnion, string>>>
| Tag<
"pointer",
WithDescription<
@@ -318,9 +326,7 @@ export type ValueSpecUnion = {
/** What tag for the specification, for tag unions */
tag: {
id: string;
/** @deprecated - optional only for backwards compatibility */
name?: string;
/** @deprecated - optional only for backwards compatibility */
name: string;
description?: string;
"variant-names": {
[key: string]: string;