nteract / rx-jupyter

🎈 RxJS 5 bindings for the Jupyter Notebook API
https://nteract.io/rx-jupyter
BSD 3-Clause "New" or "Revised" License
13 stars 10 forks source link

Document models for CREATE/UPDATE functions #29

Open jdetle opened 7 years ago

jdetle commented 7 years ago

Currently we have a TODO:

**
 * TODO: Explicit typing of the payloads for content
 *
 * name (string): Name of file or directory, equivalent to the last part of the path ,
 * path (string): Full path for file or directory ,
 * type (string): Type of content = ['directory', 'file', 'notebook']
 *                stringEnum:"directory", "file", "notebook",
 * writable (boolean): indicates whether the requester has permission to edit the file ,
 * created (string): Creation timestamp ,
 * last_modified (string): Last modified timestamp ,
 * mimetype (string): The mimetype of a file. If content is not null, and type is 'file',
 *                    this will contain the mimetype of the file, otherwise this will be null. ,
 * content (string): The content, if requested (otherwise null). Will be an array
 *                   if type is 'directory' ,
 * format (string): Format of content (one of null, 'text', 'base64', 'json')
 */

What do you mean by making this explicitly typed @rgbkrk? I'm afraid I don't understand the task.

rgbkrk commented 7 years ago

It either means that we'll write this library in TypeScript, write flow definitions, and/or write ESDoc for the type.