From 977366f8723fd581b8ab2476e23539c401786602 Mon Sep 17 00:00:00 2001 From: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Date: Mon, 30 Jan 2023 15:03:30 -0700 Subject: [PATCH 1/2] make name optional on union type --- types.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types.ts b/types.ts index d3702a5..23cd071 100644 --- a/types.ts +++ b/types.ts @@ -318,8 +318,8 @@ export type ValueSpecUnion = { /** What tag for the specification, for tag unions */ tag: { id: string; - name: string; - description?: string; + name?: string; // optional for backwards compatibility - removed in 0.3.4 + description?: string; // optional for backwards compatibility - removed in 0.3.4 "variant-names": { [key: string]: string; }; From 2d41dd4c789314a16a81ce2a103c2f868fe90c6c Mon Sep 17 00:00:00 2001 From: Lucy Cifferello <12953208+elvece@users.noreply.github.com> Date: Mon, 30 Jan 2023 15:12:55 -0700 Subject: [PATCH 2/2] adjust comment --- types.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/types.ts b/types.ts index 23cd071..0677ac7 100644 --- a/types.ts +++ b/types.ts @@ -220,7 +220,7 @@ export type WithNullable = T & { export type DefaultString = | string | { - /** The chars available for the randome generation */ + /** The chars available for the random generation */ charset?: string; /** Length that we generate to */ len: number; @@ -318,8 +318,10 @@ export type ValueSpecUnion = { /** What tag for the specification, for tag unions */ tag: { id: string; - name?: string; // optional for backwards compatibility - removed in 0.3.4 - description?: string; // optional for backwards compatibility - removed in 0.3.4 + /** @deprecated - optional only for backwards compatibility */ + name?: string; + /** @deprecated - optional only for backwards compatibility */ + description?: string; "variant-names": { [key: string]: string; };