Skip to content

Commit 83a7215

Browse files
tolutolu
committed
chrome: use @deprecated where appropiate and add documentation strings
1 parent 2a71467 commit 83a7215

File tree

1 file changed

+68
-44
lines changed

1 file changed

+68
-44
lines changed

‎chrome/chrome-cast.d.ts

Lines changed: 68 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,14 @@ declare module chrome.cast {
106106
}
107107

108108
/**
109-
* @const {!Array.<number>}
110-
* @see https://developers.google.com/cast/docs/reference/chrome/
109+
* @const {!Array<number>}
110+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast#.VERSION
111111
*/
112112
var VERSION: Array<number>;
113113

114114
/**
115115
* @type {boolean}
116+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast#.isAvailable
116117
*/
117118
var isAvailable: boolean;
118119

@@ -169,7 +170,7 @@ declare module chrome.cast {
169170
): void
170171

171172
/**
172-
* @param {!Array.<chrome.cast.Receiver>} receivers
173+
* @param {!Array<chrome.cast.Receiver>} receivers
173174
* @param {function()} successCallback
174175
* @param {function(chrome.cast.Error)} errorCallback
175176
*/
@@ -194,7 +195,7 @@ declare module chrome.cast {
194195
/**
195196
* @param {!chrome.cast.SessionRequest} sessionRequest
196197
* @param {function(!chrome.cast.Session)} sessionListener
197-
* @param {function(!chrome.cast.ReceiverAvailability,Array.<Object>)}
198+
* @param {function(!chrome.cast.ReceiverAvailability,Array<Object>)}
198199
* receiverListener
199200
* @param {chrome.cast.AutoJoinPolicy=} opt_autoJoinPolicy
200201
* @param {chrome.cast.DefaultActionPolicy=} opt_defaultActionPolicy
@@ -216,14 +217,14 @@ declare module chrome.cast {
216217
defaultActionPolicy: chrome.cast.DefaultActionPolicy;
217218
}
218219

219-
/**
220-
* @param {!chrome.cast.ErrorCode} code
221-
* @param {string=} opt_description
222-
* @param {Object=} opt_details
223-
* @constructor
224-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Error
225-
*/
226220
interface Error {
221+
/**
222+
* @param {!chrome.cast.ErrorCode} code
223+
* @param {string=} opt_description
224+
* @param {Object=} opt_details
225+
* @constructor
226+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Error
227+
*/
227228
new(
228229
code: chrome.cast.ErrorCode,
229230
description?: string,
@@ -252,7 +253,11 @@ declare module chrome.cast {
252253
}
253254

254255
interface SenderApplication {
255-
256+
/**
257+
* @param {!chrome.cast.SenderPlatform} platform
258+
* @constructor
259+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.SenderApplication
260+
*/
256261
new(
257262
platform: chrome.cast.SenderPlatform
258263
):SenderApplication;
@@ -265,7 +270,7 @@ declare module chrome.cast {
265270
interface SessionRequest {
266271
/**
267272
* @param {string} appId
268-
* @param {!Array.<chrome.cast.Capability>=} opt_capabilities
273+
* @param {!Array<chrome.cast.Capability>=} opt_capabilities
269274
* @param {number=} opt_timeout
270275
* @constructor
271276
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.SessionRequest
@@ -287,7 +292,7 @@ declare module chrome.cast {
287292
* @param {string} sessionId
288293
* @param {string} appId
289294
* @param {string} displayName
290-
* @param {!Array.<chrome.cast.Image>} appImages
295+
* @param {!Array<chrome.cast.Image>} appImages
291296
* @param {!chrome.cast.Receiver} receiver
292297
* @constructor
293298
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Session
@@ -436,7 +441,7 @@ declare module chrome.cast {
436441
/**
437442
* @param {string} label
438443
* @param {string} friendlyName
439-
* @param {Array.<chrome.cast.Capability>=} opt_capabilities
444+
* @param {Array<chrome.cast.Capability>=} opt_capabilities
440445
* @param {chrome.cast.Volume=} opt_volume
441446
* @constructor
442447
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.Receiver
@@ -459,7 +464,7 @@ declare module chrome.cast {
459464
interface ReceiverDisplayStatus {
460465
/**
461466
* @param {string} statusText
462-
* @param {!Array.<chrome.cast.Image>} appImages
467+
* @param {!Array<chrome.cast.Image>} appImages
463468
* @constructor
464469
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.ReceiverDisplayStatus
465470
*/
@@ -558,7 +563,8 @@ declare module chrome.cast.media {
558563
}
559564

560565
/**
561-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest
566+
* @enum {string}
567+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media#.RepeatMode
562568
*/
563569
interface RepeatMode {
564570
OFF:string;
@@ -567,10 +573,12 @@ declare module chrome.cast.media {
567573
ALL_AND_SHUFFLE:string;
568574
}
569575

570-
/**
571-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueItem
572-
*/
573576
interface QueueItem {
577+
/**
578+
* @param {!chrome.cast.media.MediaInfo} mediaInfo
579+
* @constructor
580+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueItem
581+
*/
574582
new(
575583
mediaInfo: chrome.cast.media.MediaInfo
576584
):QueueItem;
@@ -584,10 +592,12 @@ declare module chrome.cast.media {
584592
startTime: number;
585593
}
586594

587-
/**
588-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest
589-
*/
590595
interface QueueLoadRequest {
596+
/**
597+
* @param {!Array<chrome.cast.media.QueueItem>} items
598+
* @constructor
599+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueLoadRequest
600+
*/
591601
new(
592602
items: Array<chrome.cast.media.QueueItem>
593603
):QueueLoadRequest;
@@ -598,10 +608,12 @@ declare module chrome.cast.media {
598608
startIndex: number;
599609
}
600610

601-
/**
602-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueInsertItemsRequest
603-
*/
604611
interface QueueInsertItemsRequest {
612+
/**
613+
* @param {!Array<chrome.cast.media.QueueItem>}
614+
* @constructor
615+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueInsertItemsRequest
616+
*/
605617
new(
606618
itemsToInsert: Array<chrome.cast.media.QueueItem>
607619
):QueueInsertItemsRequest;
@@ -611,10 +623,12 @@ declare module chrome.cast.media {
611623
items: Array<chrome.cast.media.QueueItem>;
612624
}
613625

614-
/**
615-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueRemoveItemsRequest
616-
*/
617626
interface QueueRemoveItemsRequest {
627+
/**
628+
* @param {!Array<number>}
629+
* @constructor
630+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueRemoveItemsRequest
631+
*/
618632
new(
619633
itemIdsToRemove: Array<number>
620634
):QueueRemoveItemsRequest;
@@ -623,10 +637,12 @@ declare module chrome.cast.media {
623637
itemIds: Array<number>;
624638
}
625639

626-
/**
627-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueReorderItemsRequest
628-
*/
629640
interface QueueReorderItemsRequest {
641+
/**
642+
* @param {!Array<number>}
643+
* @constructor
644+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueReorderItemsRequest
645+
*/
630646
new(
631647
itemIdsToReorder: Array<number>
632648
):QueueReorderItemsRequest;
@@ -636,10 +652,12 @@ declare module chrome.cast.media {
636652
itemIds: Array<number>;
637653
}
638654

639-
/**
640-
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueUpdateItemsRequest
641-
*/
642655
interface QueueUpdateItemsRequest {
656+
/**
657+
* @param {!Array<chrome.cast.media.QueueItem>}
658+
* @constructor
659+
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.QueueUpdateItemsRequest
660+
*/
643661
new(
644662
itemsToUpdate: Array<chrome.cast.media.QueueItem>
645663
):QueueUpdateItemsRequest;
@@ -802,7 +820,7 @@ declare module chrome.cast.media {
802820

803821
interface EditTracksInfoRequest {
804822
/**
805-
* @param {Array.<number>=} opt_activeTrackIds
823+
* @param {Array<number>=} opt_activeTrackIds
806824
* @param {chrome.cast.media.TextTrackStyle=} opt_textTrackStyle
807825
* @constructor
808826
* @see https://developers.google.com/cast/docs/reference/chrome/chrome.cast.media.EditTracksInfoRequest
@@ -826,11 +844,11 @@ declare module chrome.cast.media {
826844
images: Array<chrome.cast.Image>;
827845
metadataType: chrome.cast.media.MetadataType;
828846
releaseDate: string;
847+
/** @deprecated. Use releaseDate instead. */
829848
releaseYear: number;
830849
subtitle: string;
831850
title: string;
832-
833-
/** Deprecated. Use metadataType instead. */
851+
/** @deprecated. Use metadataType instead. */
834852
type: chrome.cast.media.MetadataType;
835853
}
836854

@@ -844,12 +862,12 @@ declare module chrome.cast.media {
844862
images: Array<chrome.cast.Image>;
845863
metadataType: chrome.cast.media.MetadataType;
846864
releaseDate: string;
865+
/** @deprecated. Use releaseDate instead. */
847866
releaseYear: number;
848867
subtitle: string;
849868
title: string;
850869
studio: string;
851-
852-
/** Deprecated. Use metadataType instead. */
870+
/** @deprecated. Use metadataType instead. */
853871
type: chrome.cast.media.MetadataType;
854872
}
855873

@@ -868,11 +886,15 @@ declare module chrome.cast.media {
868886
images: Array<chrome.cast.Image>;
869887
originalAirdate: string;
870888

871-
/** Deprecated. Use metadataType instead. */
889+
/** @deprecated. Use metadataType instead. */
872890
type: chrome.cast.media.MetadataType;
891+
/** @deprecated. Use title instead. */
873892
episodeTitle: string;
893+
/** @deprecated. Use season instead. */
874894
seasonNumber: number;
895+
/** @deprecated. Use episode instead. */
875896
episodeNumber: number;
897+
/** @deprecated. Use originalAirdate instead. */
876898
releaseYear: number;
877899
}
878900

@@ -895,9 +917,11 @@ declare module chrome.cast.media {
895917
images: Array<chrome.cast.Image>;
896918
releaseDate: string;
897919

898-
/** Deprecated. Use metadataType instead. */
920+
/** @deprecated. Use metadataType instead. */
899921
type: chrome.cast.media.MetadataType;
922+
/** @deprecated. Use artist instead. */
900923
artistName: string;
924+
/** @deprecated. Use releaseDate instead. */
901925
releaseYear: number;
902926
}
903927

@@ -919,7 +943,7 @@ declare module chrome.cast.media {
919943
height: number;
920944
creationDateTime: string;
921945

922-
/** Deprecated. Use metadataType instead. */
946+
/** @deprecated. Use metadataType instead. */
923947
type: chrome.cast.media.MetadataType;
924948
}
925949

@@ -973,7 +997,7 @@ declare module chrome.cast.media {
973997
supportedMediaCommands: Array<chrome.cast.media.MediaCommand>;
974998
volume: chrome.cast.Volume;
975999

976-
/** Deprecated. Use getEstimatedTime instead */
1000+
/** @deprecated. Use getEstimatedTime instead */
9771001
currentTime: number;
9781002

9791003
/**

0 commit comments

Comments
 (0)