jsdoc comments on entities

This commit is contained in:
azivner
2018-08-22 23:37:06 +02:00
parent 668528d5eb
commit d4fbe28517
10 changed files with 314 additions and 24 deletions

View File

@@ -3,6 +3,16 @@
const Entity = require('./entity');
const dateUtils = require('../services/date_utils');
/**
* ApiToken is an entity representing token used to authenticate against Trilium API from client applications. Currently used only by Trilium Sender.
*
* @param {string} apiTokenId - primary key
* @param {string} token
* @param {boolean} isDeleted - true if API token is deleted
* @param {string} dateCreated
*
* @extends Entity
*/
class ApiToken extends Entity {
static get entityName() { return "api_tokens"; }
static get primaryKeyName() { return "apiTokenId"; }