Skip to content

Commit f29633d

Browse files
author
James Lees
committed
Add comment about base client
1 parent a0cc09e commit f29633d

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/base-client.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,19 @@ export const RegistrationState = Object.freeze({
1515
PERMISSION_DENIED: 'PERMISSION_DENIED',
1616
});
1717

18+
/* BaseClient is an abstract client containing functionality shared between
19+
* safari and web push clients. Platform specific classes should extend this
20+
* class. This method expects sub classes to implement the following public
21+
* methods:
22+
* async start()
23+
* async getRegistrationState() {
24+
* async stop() {
25+
* async clearAllState() {
26+
*
27+
* It also assumes that the following private methods are implemented:
28+
* async _init()
29+
* async _detectSubscriptionChange()
30+
*/
1831
export default class BaseClient {
1932
constructor(config, platform) {
2033
if (this.constructor === BaseClient) {

0 commit comments

Comments
 (0)