chore: types & doc

SuperFlyTV · Oct 20, 2023 · 39e9204 · 39e9204
1 parent 00e6045
commit 39e9204
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,7 @@ _Internal changes, like typos or internal fixes to the json-schema are not liste
 
 * New **GDDType**: `color-rrggbbaa` [PR #16](https://github.com/SuperFlyTV/GraphicsDataDefinition/pull/16)
 * Version 1.0.0 of the [javascript npm library](https://www.npmjs.com/package/graphics-data-definition) is released.
+* Optional properties `authorName` and `authorEmail` added, [PR #17](https://github.com/SuperFlyTV/GraphicsDataDefinition/pull/17)
 
 ## 2022-10-28
 

diff --git a/lib/javascript-library/src/lib/types.ts b/lib/javascript-library/src/lib/types.ts
@@ -23,6 +23,10 @@ export interface GDDSchema extends GDDSchemaPropertyObject {
 			}
 		}
 	}
+	/** Name of the author. */
+	authorName?: string
+	/** Email to the author. */
+	authorEmail?: string
 }
 
 export type GDDSchemaProperty =

diff --git a/lib/unit-tests/__tests__/basic.test.ts b/lib/unit-tests/__tests__/basic.test.ts
@@ -86,6 +86,7 @@ describe('Schema - Basic types', () => {
 			validateSchema({
 				type: 'object',
 				properties: {},
+				// @ts-expect-error number, instead of string
 				authorName: 123, // bad type
 			})
 		).toMatch(/not.*string/)