feat(docs): add mkdocs

This commit is contained in:
Jef LeCompte
2020-12-07 00:18:43 -05:00
parent bc2272e59a
commit 243109a4ff
53 changed files with 1112 additions and 644 deletions
+4 -1
View File
@@ -9,7 +9,10 @@ declare module 'play-sound' {
export interface PlaySound {
player: string;
play: ((file: string, callback: (error: Error) => void) => PlayerProcess) &
play: ((
file: string,
callback: (error: Error) => void
) => PlayerProcess) &
((
file: string,
options: PlayOptions,
+20 -5
View File
@@ -18,7 +18,10 @@ declare module '@jef/pushbullet' {
export interface PushBulletStream {
connect: () => void;
close: () => void;
on: ((event: 'connect' | 'close' | 'nop', callback: () => void) => void) &
on: ((
event: 'connect' | 'close' | 'nop',
callback: () => void
) => void) &
((event: 'error', callback: (error: any) => void) => void) &
((event: 'message', callback: (message: any) => void) => void) &
((event: 'tickle', callback: (tickle: any) => void) => void) &
@@ -30,7 +33,10 @@ declare module '@jef/pushbullet' {
me(callback: PushBulletCallback);
devices(options: ListOptions, callback: PushBulletCallback);
devices(callback: PushBulletCallback);
createDevice(options: Record<string, any>, callback: PushBulletCallback);
createDevice(
options: Record<string, any>,
callback: PushBulletCallback
);
updateDevice(
deviceIden: string,
deviceOptions: Record<string, any>,
@@ -65,8 +71,14 @@ declare module '@jef/pushbullet' {
subscriptions(callback: PushBulletCallback);
subscribe(channelTag: string, callback: PushBulletCallback);
unsubscribe(subscriptionIden: string, callback: PushBulletCallback);
muteSubscription(subscriptionIden: string, callback: PushBulletCallback);
unmuteSubscription(subscriptionIden: string, callback: PushBulletCallback);
muteSubscription(
subscriptionIden: string,
callback: PushBulletCallback
);
unmuteSubscription(
subscriptionIden: string,
callback: PushBulletCallback
);
channelInfo(channelTag: string, callback: PushBulletCallback);
chats(options: ListOptions, callback: PushBulletCallback);
chats(callback: PushBulletCallback);
@@ -75,7 +87,10 @@ declare module '@jef/pushbullet' {
muteChat(chatIden: string, callback: PushBulletCallback);
unmuteChat(chatIden: string, callback: PushBulletCallback);
sendSMS(options: Record<string, any>, callback: PushBulletCallback);
sendClipboard(options: Record<string, any>, callback: PushBulletCallback);
sendClipboard(
options: Record<string, any>,
callback: PushBulletCallback
);
dismissEphemeral(
options: Record<string, any>,
callback: PushBulletCallback