From f6c2d6b5d2b9e1615d3dfdac4faebc56978c84a4 Mon Sep 17 00:00:00 2001 From: Jordan Eldredge Date: Thu, 2 May 2019 07:30:43 -0700 Subject: [PATCH] Document semi-private API --- js/media/index.ts | 3 +++ js/webampLazy.tsx | 1 + 2 files changed, 4 insertions(+) diff --git a/js/media/index.ts b/js/media/index.ts index 9c520de1..8779f6c8 100644 --- a/js/media/index.ts +++ b/js/media/index.ts @@ -12,6 +12,9 @@ interface StereoBalanceNodeType extends AudioNode { }; } +// NOTE: While this is not technically a public API, https://winampify.io/ is +// replacing this class with a custom version. Breaking changes to this API +// surface should be communicated to Remi. export default class Media { _emitter: Emitter; _context: AudioContext; diff --git a/js/webampLazy.tsx b/js/webampLazy.tsx index 2bbe5d76..7b48b296 100644 --- a/js/webampLazy.tsx +++ b/js/webampLazy.tsx @@ -125,6 +125,7 @@ interface PrivateOptions { }; }; __butterchurnOptions: ButterchurnOptions; + // This is used by https://winampify.io/ to proxy through to Spotify's API. __customMediaClass: typeof Media; // This should have the same interface as Media }