Global

Members

(constant) pending :Set.<Error>

Liste d'erreurs concernant chaque pending Promise (ajouté à la création de la Promise et viré au resolve/reject)

Type:
  • Set.<Error>
Source:

(constant) TTL_DEFAULT :number

ttl par défaut (pour set si non fourni)

Type:
  • number
Source:

(constant) TTL_MAX :number

ttl max (si un nb plus élevé est fourni il sera ramené à cette valeur)

Type:
  • number
Source:

Methods

addConditions(Entity, wheres) → {EntityQuery}

Traduit l'objet wheres en requête lassi sur Entity

Parameters:
Name Type Description
Entity Entity
wheres string

un objet json (cf help pour la syntaxe)
Source:
Returns:
Type
EntityQuery

castToType(value, type) → {*}

cast de value en type

Parameters:
Name Type Description
value *
type string

boolean|string|integer|date
Source:
Throws:

si le type n'est pas boolean|string|integer|date

Returns:

value mise dans le type voulu

Type
*

count(entityName, wheresopt, done)

Affiche le nombre d'entités répondants aux critères

Parameters:
Name Type Attributes Description
entityName string

Le nom de l'entité, mettre help pour avoir la syntaxe des arguments
wheres string <optional>

Liste de conditions (array en json)
done errorCallback
Source:

getPastDate(nbDays) → {Date}

Retourne la date de nbDays dans le passé (à partir du moment de l'appel)

Parameters:
Name Type Description
nbDays
Source:
Returns:
Type
Date

greaterThan(value) → {EntityQuery}

Fait correspondre les enregistrement dont la valeur d'index supérieure à une date donnée

Parameters:
Name Type Description
value Date

La valeur à faire correspondre.
Source:
Returns:

La requête (pour chaînage)

Type
EntityQuery

HtmlTransport()

Gestion du transport HTML.

Source:

isAllowedIndexType(type) → {boolean}

Retourne true si le type d'index est géré

Parameters:
Name Type Description
type string
Source:
Returns:
Type
boolean

lowerThan(value) → {EntityQuery}

Fait correspondre les enregistrement dont la valeur d'index est inférieure à une date donnée

Parameters:
Name Type Description
value Date

La valeur à faire correspondre.
Source:
Returns:

La requête (pour chaînage)

Type
EntityQuery

pathtoRegexp()

Fonction fauchée ici : http://forbeslindesay.github.io/express-route-tester/
car le module https://github.com/component/path-to-regexp marche finalement
moins bien...

Source:

purgeDeleted(entity, nbDays, done)

Purge les entités plus vieilles que le nombre de jours indiqué (n × 24h)

Parameters:
Name Type Description
entity string | Object

Le nom de l'entité, mettre help pour avoir la syntaxe des arguments
nbDays string

Nombre de jours minimum pour que l'entité soit purgée
done errorCallback

Callback
Source:

reindexAll(entityName, argSupopt, done)

Réindexe toutes les entités entityName

Parameters:
Name Type Attributes Description
entityName string
argSup string <optional>
done errorCallback
Source:

runPendingUpdates(done)

Applique les mises à jour en attente

Parameters:
Name Type Description
done errorCallback
Source:

select(entityName, fieldsopt, wheresopt, optionsopt, done)

Affiche les entités demandées

Parameters:
Name Type Attributes Default Description
entityName string

Le nom de l'entité, mettre help pour avoir la syntaxe des arguments
fields string <optional>
 ''

Liste des champs à afficher (séparateur virgule)
wheres string <optional>
 ''

Liste de conditions (array en json)
options string <optional>
 ''

Liste de conditions (array en json)
done errorCallback
Source:

setMaintenance(mode, done)

Active/désactive le mode maintenance

Parameters:
Name Type Description
mode string

on|off pour activer ou désactiver le mode maintenance
done errorCallback
Source:

startLassi(options) → {Lassi}

Démarre lassi avec les options fournies

Parameters:
Name Type Description
options string | object

Si string interprété comme options.root

Properties
Name Type Attributes Default Description
cli boolean <optional>
 false

Passer true pour activer les services *-cli (et ne pas lancer le serveur http)
noGlobalLassi boolean <optional>
 false

@todo Passer true pour que lassi ne soit pas mis en global
root string

la racine de l'appli
settings object <optional>

Passer un objet de settings complet (sinon ira chercher ${root}/config.js)
Source:
Returns:
Type
Lassi

validAll(entityName, done)

Passe en revue toutes les entités entityName pour vérifier la validation (schema + beforeStore),
sans modification de l'existant.
Ne renvoie jamais d'erreur, seulement la liste des oids invalides

Parameters:
Name Type Description
entityName string
done function

appelée avec (null, string[]), le 2e paramètre est la liste des oids qui ne passent pas la validation
Source:

Type Definitions

duplicateCallback(error, callback)

Appelée en cas d'erreur de doublon, son contexte (son this) sera l'entité ayant provoqué le plantage

Parameters:
Name Type Description
error duplicateError

L'erreur de doublon
callback storeCallback

La callback passée au store
Source:

duplicateError

Erreur provoqué par un doublon au store

Type:
  • Error
Properties:
Name Type Description
type string

Toujours 'duplicate'
original Error

L'erreur originale retournée par mongo
entityName string

Le nom de l'entity
indexName string

Le nom de l'index (1er argument passé à EntityDefinition#defineIndex)
mongoIndexName string

Le nom de l'index mongo (créé par lassi)
Source:

entityContextCallback(cb)

Modifie ou valide une entity (mise en contexte, elle sera le this de cette fct)

Parameters:
Name Type Description
cb simpleCallback

à appeller avec une erreur éventuelle quand les modif seront finies
Source:

errorCallback(erroropt)

Parameters:
Name Type Attributes Description
error Error <optional>
Source:

expressMiddleware

Source:

getMaintenanceModeCallback(result)

Parameters:
Name Type Description
result Object
Properties
Name Type Description
mode string

on|off
reason string

'manuel' ou 'update' ou 'settings' (ou n'importe quelle string mise dans le fichier de lock)
Source:

getPendingUpdatesCallback(erroropt, updates)

Parameters:
Name Type Attributes Description
error Error <optional>
updates Array.<PendingUpdate> | undefined

les updates en attente
(undefined si y'a un pb pour les trouver ou les appliquer,
pb signalés en console.error ou dans le log d'erreur)
Source:

getUpdatesAboveVersionCallback(error, updates)

Parameters:
Name Type Description
error
updates Array.<PendingUpdate>

tableau des updates qui démarre avec l'update version+1 (et tous les suivants)
Source:

indexDefinition

Index d'entity

Properties:
Name Type Attributes Description
fieldType string <optional>

Si précisé il y aura du cast avant store et sur les arguments des EntityQuery (ça empêche d'utiliser directement la valeur de _data comme index)
indexName string
indexOptions object <optional>
Properties
Name Type Attributes Description
unique boolean <optional>
sparse boolean <optional>
mongoIndexName string
path string

Le chemin de l'index dans le document mongo (indexName ou _data.indexName suivant useData)
useData boolean
Source:

indexesCallback(erroropt, createdIndexesopt)

Parameters:
Name Type Attributes Description
error Error <optional>
createdIndexes Array.<Object> <optional>

tableau d'index mongo (retourné par listIndexes ou createIndexes)
Source:

keysRedisCallback(error, keys)

Parameters:
Name Type Description
error RedisError
keys Iterator.<string>
Source:

PendingUpdate

Properties:
Name Type Attributes Description
$num number

Le n° de l'update (le nom du js, qui sera le num du LassiUpdate que l'on créera après exécution
isNotBlocking boolean <optional>

mettre à true si on peut lancer l'appli sans attendre la fin de l'update
name string
description string <optional>
run runCallback

La fonction à appeler pour lancer l'update
Source:

purgeCallback(error, nbDeleted)

Parameters:
Name Type Description
error Error
nbDeleted number

le nb d'objets effacés
Source:

redisClientDeleteCallback(error, result)

Parameters:
Name Type Description
error RedisError
result RedisResult
Source:

redisClientGetCallback(error, value)

Parameters:
Name Type Description
error RedisError
value *

Valeur récupérée en cache ou undefined
Source:

redisClientSetCallback(error, result)

Parameters:
Name Type Description
error RedisError
result RedisResult
Source:

redisOptions

Options pour le client redis
Il faut fournir obligatoirement

  • path ou url ou host ET port
Type:
  • Object
Properties:
Name Type Attributes Description
path string <optional>

socket unix
url string <optional>

Format [redis:]//[[user][:password@]][host][:port][/db-number][?db=db-number[&password=bar[&option=value]]]
Source:
See:

runCallback(callback)

Parameters:
Name Type Description
callback errorCallback

rappelée avec l'erreur éventuelle
Source:

simpleCallback()

Callback à rappeler sans argument

Source:

simpleCallback(erroropt)

Parameters:
Name Type Attributes Description
error Error <optional>
Source:

softPurgeCallback(error, nbSoftDeleted)

Parameters:
Name Type Description
error Error
nbSoftDeleted number

le nb d'objets softDeleted
Source:

updateCallback(error, updateNum)

Parameters:
Name Type Description
error Error | null | undefined
updateNum number

0 si y'avait pas d'update à lancer
Source:

updateExistCallback(error, exist)

Parameters:
Name Type Description
error
exist boolean

false si l'update numéro updateNum n'existe pas
Source:

validationCallback(error, data)

Parameters:
Name Type Description
error Error
data Object

la valeur de la promesse résolue par la fn retournée par ajv.compile
Source: