Skip to content

Commit f55937d

Browse files
committed
Update typedefs
1 parent 1703b84 commit f55937d

File tree

4 files changed

+33
-12
lines changed

4 files changed

+33
-12
lines changed

.travis/build-types.ts

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@ interface Tree {
3636
[k: string]: AnyType;
3737
}
3838

39-
type AnyType = PrimitiveType | ObjectType | OutputType | ArrayType | SceneType | SceneItemType | SceneItemTransformType | OBSStatsType;
40-
4139
interface PrimitiveType {
4240
type: 'string' | 'number' | 'boolean';
4341
optional: boolean;
@@ -57,7 +55,7 @@ interface OutputType {
5755

5856
interface ArrayType {
5957
type: 'array';
60-
items: PrimitiveType | ObjectType | OutputType | SceneType | SceneItemType | SceneItemTransformType;
58+
items: PrimitiveType | ObjectType | OutputType | SceneType | SceneItemType | SceneItemTransformType | ScenesCollectionType;
6159
optional: boolean;
6260
}
6361

@@ -81,6 +79,13 @@ interface OBSStatsType {
8179
optional: boolean;
8280
}
8381

82+
interface ScenesCollectionType {
83+
type: 'ObsWebSocket.ScenesCollection';
84+
optional: boolean;
85+
}
86+
87+
type AnyType = PrimitiveType | ObjectType | OutputType | ArrayType | SceneType | SceneItemType | SceneItemTransformType | OBSStatsType | ScenesCollectionType;
88+
8489
const DOTS_REGEX = /\./g;
8590
const outFile = path.join(__dirname, '../types/index.d.ts');
8691
async function getLatestComments(): Promise<any> {
@@ -423,6 +428,20 @@ function resolveType(inType: string): AnyType {
423428
},
424429
optional: isOptional
425430
};
431+
case 'array<scenescollection>':
432+
return {
433+
type: 'array',
434+
items: {
435+
type: 'ObsWebSocket.ScenesCollection',
436+
optional: true
437+
},
438+
optional: isOptional
439+
};
440+
case 'scenescollection':
441+
return {
442+
type: 'ObsWebSocket.ScenesCollection',
443+
optional: true
444+
};
426445
case 'sceneitemtransform':
427446
return {
428447
type: 'ObsWebSocket.SceneItemTransform',

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ OBSWebSocket.JS allows Javascript-based connections to the Open Broadcaster plug
2222

2323
## Installation
2424

25+
Please note that the version of obs-websocket-js matches the release version of obs-websocket
26+
2527
```sh
2628
npm install obs-websocket-js --save
2729

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "obs-websocket-js",
3-
"version": "4.0.2",
2+
"name": "@duncte123/obs-websocket-js",
3+
"version": "4.9.1",
44
"description": "OBS Websocket API in Javascript, consumes @Palakis/obs-websocket",
5-
"author": "Brendan Hagan (haganbmj)",
5+
"author": "duncte123",
66
"license": "MIT",
7-
"repository": "haganbmj/obs-websocket-js",
8-
"repoUrl": "https://github.com/haganbmj/obs-websocket-js",
7+
"repository": "duncte123/obs-websocket-js",
8+
"repoUrl": "https://github.com/duncte123/obs-websocket-js",
99
"keywords": [
1010
"obs",
1111
"studio",
@@ -69,9 +69,9 @@
6969
"webpack-cli": "^3.3.10"
7070
},
7171
"bugs": {
72-
"url": "https://github.com/haganbmj/obs-websocket-js/issues"
72+
"url": "https://github.com/duncte123/obs-websocket-js/issues"
7373
},
74-
"homepage": "https://github.com/haganbmj/obs-websocket-js#readme",
74+
"homepage": "https://github.com/duncte123/obs-websocket-js#readme",
7575
"eslintConfig": {
7676
"extends": "xo-space/esnext"
7777
},

0 commit comments

Comments
 (0)