Skip to content

Commit c7c40fe

Browse files
crisbetommalerba
authored andcommitted
build: set up API golden file for youtube-player package (#17426)
Now that the `youtube-player` package has been released, we need an API golden file to make sure that we don't make any unintended API changes.
1 parent 3e5e9db commit c7c40fe

File tree

3 files changed

+47
-0
lines changed

3 files changed

+47
-0
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,7 @@
294294
/tools/public_api_guard/material/tooltip.d.ts @andrewseguin
295295
/tools/public_api_guard/material/tree.d.ts @jelbourn @andrewseguin
296296
/tools/public_api_guard/material/material.d.ts @jelbourn
297+
/tools/public_api_guard/youtube-player/youtube-player.d.ts @jelbourn @nathantate
297298

298299
# Misc
299300
/* @angular/dev-infra-components @jelbourn

tools/public_api_guard/generate-guard-tests.bzl

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,6 @@ def generate_test_targets(golden_files):
3131
],
3232
golden = "angular_material/tools/public_api_guard/%s" % golden_file,
3333
use_angular_tag_rules = False,
34+
# Required for the `youtube-player` package.
35+
allow_module_identifiers = ["YT"],
3436
)
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
export declare class YouTubePlayer implements AfterViewInit, OnDestroy, OnInit {
2+
apiChange: EventEmitter<YT.PlayerEvent>;
3+
endSeconds: number | undefined;
4+
error: EventEmitter<YT.OnErrorEvent>;
5+
height: number | undefined;
6+
playbackQualityChange: EventEmitter<YT.OnPlaybackQualityChangeEvent>;
7+
playbackRateChange: EventEmitter<YT.OnPlaybackRateChangeEvent>;
8+
ready: EventEmitter<YT.PlayerEvent>;
9+
showBeforeIframeApiLoads: boolean | undefined;
10+
startSeconds: number | undefined;
11+
stateChange: EventEmitter<YT.OnStateChangeEvent>;
12+
suggestedQuality: YT.SuggestedVideoQuality | undefined;
13+
videoId: string | undefined;
14+
width: number | undefined;
15+
youtubeContainer: ElementRef<HTMLElement>;
16+
constructor(_ngZone: NgZone);
17+
createEventsBoundInZone(): YT.Events;
18+
getAvailablePlaybackRates(): number[];
19+
getAvailableQualityLevels(): YT.SuggestedVideoQuality[];
20+
getCurrentTime(): number;
21+
getDuration(): number;
22+
getPlaybackQuality(): YT.SuggestedVideoQuality;
23+
getPlaybackRate(): number;
24+
getPlayerState(): YT.PlayerState | undefined;
25+
getVideoEmbedCode(): string;
26+
getVideoLoadedFraction(): number;
27+
getVideoUrl(): string;
28+
getVolume(): number;
29+
isMuted(): boolean;
30+
mute(): void;
31+
ngAfterViewInit(): void;
32+
ngOnDestroy(): void;
33+
ngOnInit(): void;
34+
pauseVideo(): void;
35+
playVideo(): void;
36+
seekTo(seconds: number, allowSeekAhead: boolean): void;
37+
setPlaybackRate(playbackRate: number): void;
38+
setVolume(volume: number): void;
39+
stopVideo(): void;
40+
unMute(): void;
41+
}
42+
43+
export declare class YouTubePlayerModule {
44+
}

0 commit comments

Comments
 (0)