API reference documentation

Summary:
Documented all exposed Sandy APIs plugin developers should know about.

Honestly didn't proof-read it myself yet, but wanted to publish this diff at least before PTO, so that the information is available to anyone interested / playing with sandy

Reviewed By: jknoxville

Differential Revision: D22976373

fbshipit-source-id: c30918201d2feeb306ca0d9a3ae1ec10bdf7e2f5

desktop/flipper-plugin/src/plugin/DevicePlugin.tsx

@@ -15,12 +15,12 @@ export type DeviceLogListener = (entry: DeviceLogEntry) => void;
 
 export type DeviceLogEntry = {
   readonly date: Date;
+  readonly type: LogLevel;
+  readonly message: string;
   readonly pid: number;
   readonly tid: number;
   readonly app?: string;
-  readonly type: LogLevel;
   readonly tag: string;
-  readonly message: string;
 };
 
 export type LogLevel =

desktop/flipper-plugin/src/plugin/Plugin.tsx

@@ -41,14 +41,6 @@ export interface PluginClient<
    */
   onDisconnect(cb: () => void): void;
 
-  /**
-   * Send a message to the connected client
-   */
-  send<Method extends keyof Methods>(
-    method: Method,
-    params: Parameters<Methods[Method]>[0],
-  ): ReturnType<Methods[Method]>;
-
   /**
    * Subscribe to a specific event arriving from the device.
    *
@@ -59,6 +51,14 @@ export interface PluginClient<
     event: Event,
     callback: (params: Events[Event]) => void,
   ): void;
+
+  /**
+   * Send a message to the connected client
+   */
+  send<Method extends keyof Methods>(
+    method: Method,
+    params: Parameters<Methods[Method]>[0],
+  ): ReturnType<Methods[Method]>;
 }
 
 /**

website/sidebars.js

@@ -90,6 +90,7 @@ module.exports = {
         'extending/fb/desktop-plugin-releases',
         // TODO: Remove once sandy is public T69061061
         'extending/fb/sandy/sandy-plugins',
+        'extending/fb/sandy/flipper-plugin',
       ]),
     ],
     'Other Platforms': [