Ver código fonte

Add docstring.

Ian Rose 6 anos atrás
pai
commit
8a86ca9c14
1 arquivos alterados com 8 adições e 0 exclusões
  1. 8 0
      packages/application/src/tokens.ts

+ 8 - 0
packages/application/src/tokens.ts

@@ -19,6 +19,14 @@ export const IConnectionLost = new Token<IConnectionLost>(
   '@jupyterlab/apputils:IConnectionLost'
 );
 
+/**
+ * A function that handles a connection to the server being lost.
+ *
+ * #### Notes
+ * The default implementation shows a simple dialog upon connection
+ * failures, but it may be overridden by extensions to perform other
+ * actions.
+ */
 export type IConnectionLost = (
   manager: ServiceManager.IManager,
   err: ServerConnection.NetworkError