chore: doc & lint

README.md

@@ -502,6 +502,7 @@ _Note: All of the properties inside of `gddPlayoutOptions` are optional._
       /**
        * This property contains an array of the supported resolutions of the GFX Template.
        * The array must contain at least one resolution.
+       * This can be used by the client to determine whether a template is compatible with the current renderer or not.
        * Examples:
        * * A template which only supports a fixed resolution and framerate:
        *   "resolutions": [{ "width": 1280, "height": 720, "framerate": 50 }]

lib/unit-tests/__tests__/lib/validator.ts

@@ -113,8 +113,6 @@ async function getJSON(filePath: string): Promise<any> {
 			if (e.message) e.message = e.message + ' ' + filePath
 			throw e
 		}
-
-
 	} else {
 		return null
 	}

lib/unit-tests/__tests__/playout-options.test.ts

@@ -125,7 +125,7 @@ test('gddPlayoutOptions.render', async () => {
 			properties: {},
 			gddPlayoutOptions: {
 				render: {
-					resolutions: [] // empty is not allowed
+					resolutions: [], // empty is not allowed
 				},
 			},
 		})
@@ -136,7 +136,7 @@ test('gddPlayoutOptions.render', async () => {
 			properties: {},
 			gddPlayoutOptions: {
 				render: {
-					resolutions: [ { width: 123 } ]
+					resolutions: [{ width: 123 }],
 				},
 			},
 		})
@@ -147,7 +147,7 @@ test('gddPlayoutOptions.render', async () => {
 			properties: {},
 			gddPlayoutOptions: {
 				render: {
-					resolutions: [ { width: "123" } ] // bad type
+					resolutions: [{ width: '123' }], // bad type
 				},
 			},
 		})
@@ -158,7 +158,7 @@ test('gddPlayoutOptions.render', async () => {
 			properties: {},
 			gddPlayoutOptions: {
 				render: {
-					resolutions: [ { width: { min: 100, max: 9999 } } ]
+					resolutions: [{ width: { min: 100, max: 9999 } }],
 				},
 			},
 		})
@@ -169,7 +169,7 @@ test('gddPlayoutOptions.render', async () => {
 			properties: {},
 			gddPlayoutOptions: {
 				render: {
-					resolutions: [ { width: { max: "two" } } ] // bad type
+					resolutions: [{ width: { max: 'two' } }], // bad type
 				},
 			},
 		})
@@ -180,7 +180,7 @@ test('gddPlayoutOptions.render', async () => {
 			properties: {},
 			gddPlayoutOptions: {
 				render: {
-					resolutions: [ { width: { max: 9000 }, height: 500, framerate: 50 } ]
+					resolutions: [{ width: { max: 9000 }, height: 500, framerate: 50 }],
 				},
 			},
 		})
@@ -191,7 +191,7 @@ test('gddPlayoutOptions.render', async () => {
 			properties: {},
 			gddPlayoutOptions: {
 				render: {
-					resolutions: [ { width: { max: 9000 }, height: 500, framerate: "50" } ] // bad type
+					resolutions: [{ width: { max: 9000 }, height: 500, framerate: '50' }], // bad type
 				},
 			},
 		})