Skip to content

Commit 654dc61

Browse files
committed
Change build-types script to take the latest commit for now
as there hasn't been a new release for a while but a lot of docs updates
1 parent 1b1b26b commit 654dc61

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

scripts/build-types.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ const headers = {
7777
Authorization: process.env.GH_TOKEN ? `token ${process.env.GH_TOKEN}` : undefined,
7878
};
7979

80-
let commit = process.argv[2] ?? process.env.GH_COMMIT;
80+
// Defaulting to the branch for now to get the latest docs-only changes
81+
let commit = process.argv[2] ?? process.env.GH_COMMIT ?? 'master';
8182
if (!commit) {
8283
const {body: release} = await got('https://api.github.com/repos/obsproject/obs-websocket/releases/latest', {
8384
headers,
@@ -104,7 +105,7 @@ protocol.enums.forEach(({enumType, enumIdentifiers}) => {
104105
});
105106

106107
const source = `/**
107-
* This file is autogenerated by scripts/generate-obs-typings.js
108+
* This file is autogenerated by scripts/build-types.ts
108109
* To update this with latest changes do npm run generate:obs-types
109110
*/
110111
import {Merge, JsonArray, JsonObject, JsonValue} from 'type-fest';

src/types.ts

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -534,7 +534,7 @@ export interface OBSEventTypes {
534534
*/
535535
inputName: string;
536536
/**
537-
* New volume level in multimap
537+
* New volume level multiplier
538538
*/
539539
inputVolumeMul: number;
540540
/**
@@ -852,6 +852,12 @@ export interface OBSEventTypes {
852852
*/
853853
eventData: JsonObject;
854854
};
855+
CustomEvent: {
856+
/**
857+
* Custom event data
858+
*/
859+
eventData: JsonObject;
860+
};
855861
}
856862

857863
// Requests and Responses
@@ -1184,14 +1190,16 @@ export interface OBSRequestTypes {
11841190
* Number of milliseconds to sleep for (if `SERIAL_REALTIME` mode)
11851191
*
11861192
* @restrictions >= 0, <= 50000
1193+
* @defaultValue Unknown
11871194
*/
1188-
sleepMillis: number;
1195+
sleepMillis?: number;
11891196
/**
11901197
* Number of frames to sleep for (if `SERIAL_FRAME` mode)
11911198
*
11921199
* @restrictions >= 0, <= 10000
1200+
* @defaultValue Unknown
11931201
*/
1194-
sleepFrames: number;
1202+
sleepFrames?: number;
11951203
};
11961204
GetInputList: {
11971205
/**
@@ -2381,7 +2389,12 @@ export interface OBSResponseTypes {
23812389
*/
23822390
savedReplayPath: string;
23832391
};
2384-
GetOutputList: undefined;
2392+
GetOutputList: {
2393+
/**
2394+
* Array of outputs
2395+
*/
2396+
outputs: JsonObject[];
2397+
};
23852398
GetOutputStatus: {
23862399
/**
23872400
* Whether the output is active
@@ -2439,7 +2452,7 @@ export interface OBSResponseTypes {
24392452
/**
24402453
* Whether the output is paused
24412454
*/
2442-
ouputPaused: boolean;
2455+
outputPaused: boolean;
24432456
/**
24442457
* Current formatted timecode string for the output
24452458
*/

0 commit comments

Comments
 (0)