classeur-api-client

Module: classeur-api-client

Node.js client for the REST API of Classeur

This is alpha software: this is the first major release of this client library. While I've done my best to write thorough unit and integration tests, there may be bugs, and the API is subject to change in future versions.

Source:
See:

Examples

Installation

npm install classeur-api-client

Usage

const ClasseurClient = require('classeur-api-client');

const myClient = new ClasseurClient({ userId: "my id", apiKey: "my key" });

myClient.getFile("some file id", function(error, result) {
    console.log(`Got a file called ${result.name}`);
    console.log(`...and some markdown: ${result.content.text}`);
});

Classes

ClasseurClient

Type Definitions

File

Object representation of a Classeur file.

Type:
  • Object
Properties:
Name Type Description
id String

The ID of the file.
name String

The name of the file, as visible in the Classeur UI.
permission *

Information on the access permissions of the file.
updated Number

Timestamp (since epoch): the last time the file was updated.
content ClasseurClient~FileContent

The content of the file.
Source:

FileContent

Object representation of a Classeur file's content.

Type:
  • Object
Properties:
Name Type Description
text String

The text content of the file.
rev Number

The revision number of the file.
properties Object

File properties.
discussions Array.<Object>

Array of objects, each representing a discussion entry regarding this file.
Source:

FileMetadata

Object representation of a Classeur file's metadata.

Type:
  • Object
Properties:
Name Type Description
id String

The ID of the file.
name String

The name of the file, as visible in the Classeur UI.
permission *

Information on the access permissions of the file.
userId String

The ID of the user who owns the file.
updated Number

Timestamp (since epoch): the last time the file was updated.
Source:

Folder

Object representation of a Classeur folder.

Type:
  • Object
Properties:
Name Type Description
id String

The ID of the folder.
name String

The name of the folder, as visible in the Classeur UI.
userId String

The ID of the user who owns the folder.
updated Number

Timestamp (since epoch): the last time the folder was updated.
files Array.<ClasseurClient~FolderFileEntry>

List of objects, each representing a file contained within the folder.
Source:

FolderFileEntry

Object representation of a Classeur file entry in a folder.

Type:
  • Object
Properties:
Name Type Description
id String

The ID of the file.
name String

The name of the file, as visible in the Classeur UI.
userId String

The ID of the user who owns the file.
updated Number

Timestamp (since epoch): the last time the file was updated.
Source:

FolderMetadata

Object representation of a Classeur folder's metadata.

Type:
  • Object
Properties:
Name Type Description
id String

The ID of the folder.
name String

The name of the folder, as visible in the Classeur UI.
userId String

The ID of the user who owns the folder.
updated Number

Timestamp (since epoch): the last time the folder was updated.
Source:

ScrubbedCallback(error, result)

Standard function(error, result) { ... } callbacks that get automatically wrapped so that either error or result must be null.

Parameters:
Name Type Argument Description
error Error | String <nullable>

An Error or error String, if an error occurred executing the function to which this callback was supplied, or null if the function was successful.
result * <nullable>

Results of the function to which this callback was supplied, or null if the function was unsuccessful.

  • result will be null even if the function was partially successful, and was supposed to return an Array; partial result arrays are removed.
Source:

UserMetadata

Object representation of a Classeur user's metadata.

Type:
  • Object
Properties:
Name Type Description
id String

The ID of the user.
name String

The name of the user.
Source: