aurelia-logging/doc/api.json

A minimal but effective logging mechanism with support for log levels and pluggable log appenders.

{"name":"aurelia-logging","children":[{"id":27,"name":"Logger","kind":128,"kindString":"Class","flags":{"isExported":true},"comment":{"shortText":"A logger logs messages to a set of appenders, depending on the log level that is set."},"children":[{"id":30,"name":"constructor","kind":512,"kindString":"Constructor","flags":{"isExported":true},"comment":{"shortText":"You cannot instantiate the logger directly - you must use the getLogger method instead."},"signatures":[{"id":31,"name":"new Logger","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"shortText":"You cannot instantiate the logger directly - you must use the getLogger method instead."},"parameters":[{"id":32,"name":"id","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"Logger","id":27}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":162,"character":16}]},{"id":28,"name":"id","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The id that the logger was created with."},"sources":[{"fileName":"aurelia-logging.d.ts","line":157,"character":4}],"type":{"type":"instrinct","name":"string"}},{"id":29,"name":"level","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"The logging severity level for this logger"},"sources":[{"fileName":"aurelia-logging.d.ts","line":162,"character":7}],"type":{"type":"instrinct","name":"number"}},{"id":33,"name":"debug","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":34,"name":"debug","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Logs a debug message."},"parameters":[{"id":35,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The message to log."},"type":{"type":"instrinct","name":"string"}},{"id":36,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":175,"character":7}]},{"id":45,"name":"error","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":46,"name":"error","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Logs an error."},"parameters":[{"id":47,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The message to log."},"type":{"type":"instrinct","name":"string"}},{"id":48,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":199,"character":7}]},{"id":37,"name":"info","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":38,"name":"info","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Logs info."},"parameters":[{"id":39,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The message to log."},"type":{"type":"instrinct","name":"string"}},{"id":40,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":183,"character":6}]},{"id":52,"name":"isDebugEnabled","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":53,"name":"isDebugEnabled","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Returns if the logger is in debug mode or not."},"type":{"type":"instrinct","name":"boolean"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":211,"character":16}]},{"id":49,"name":"setLevel","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":50,"name":"setLevel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the level of logging for this logger instance"},"parameters":[{"id":51,"name":"level","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Matches a value of logLevel specifying the level of logging.\n"},"type":{"type":"instrinct","name":"number"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":206,"character":10}]},{"id":41,"name":"warn","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":42,"name":"warn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Logs a warning."},"parameters":[{"id":43,"name":"message","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The message to log."},"type":{"type":"instrinct","name":"string"}},{"id":44,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":191,"character":6}]}],"groups":[{"title":"Constructors","kind":512,"children":[30]},{"title":"Properties","kind":1024,"children":[28,29]},{"title":"Methods","kind":2048,"children":[33,45,37,52,49,41]}],"sources":[{"fileName":"aurelia-logging.d.ts","line":152,"character":27}]},{"id":10,"name":"Appender","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Implemented by classes which wish to append log data to a target data store."},"children":[{"id":11,"name":"debug","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":12,"name":"debug","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Appends a debug log."},"parameters":[{"id":13,"name":"logger","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The source logger."},"type":{"type":"reference","name":"Logger","id":27}},{"id":14,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":49,"character":7}]},{"id":23,"name":"error","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":24,"name":"error","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Appends an error log."},"parameters":[{"id":25,"name":"logger","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The source logger."},"type":{"type":"reference","name":"Logger","id":27}},{"id":26,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":73,"character":7}]},{"id":15,"name":"info","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":16,"name":"info","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Appends an info log."},"parameters":[{"id":17,"name":"logger","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The source logger."},"type":{"type":"reference","name":"Logger","id":27}},{"id":18,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":57,"character":6}]},{"id":19,"name":"warn","kind":2048,"kindString":"Method","flags":{"isExported":true},"signatures":[{"id":20,"name":"warn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Appends a warning log."},"parameters":[{"id":21,"name":"logger","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The source logger."},"type":{"type":"reference","name":"Logger","id":27}},{"id":22,"name":"rest","kind":32768,"kindString":"Parameter","flags":{"isRest":true},"comment":{"text":"The data to log.\n"},"type":{"type":"instrinct","isArray":true,"name":"any"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":65,"character":6}]}],"groups":[{"title":"Methods","kind":2048,"children":[11,23,15,19]}],"sources":[{"fileName":"aurelia-logging.d.ts","line":41,"character":33}]},{"id":2,"name":"LogLevel","kind":256,"kindString":"Interface","flags":{"isExported":true},"comment":{"shortText":"Specifies the available logging levels."},"indexSignature":[{"id":8,"name":"__index","kind":8192,"kindString":"Index signature","flags":{},"comment":{"shortText":"Additional log levels defined at runtime."},"parameters":[{"id":9,"name":"level","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"instrinct","name":"number"}}],"children":[{"id":7,"name":"debug","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Log all messages."},"sources":[{"fileName":"aurelia-logging.d.ts","line":30,"character":7}],"type":{"type":"instrinct","name":"number"}},{"id":4,"name":"error","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Log only error messages."},"sources":[{"fileName":"aurelia-logging.d.ts","line":15,"character":7}],"type":{"type":"instrinct","name":"number"}},{"id":6,"name":"info","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Log informational messages or above."},"sources":[{"fileName":"aurelia-logging.d.ts","line":25,"character":6}],"type":{"type":"instrinct","name":"number"}},{"id":3,"name":"none","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"No logging."},"sources":[{"fileName":"aurelia-logging.d.ts","line":10,"character":6}],"type":{"type":"instrinct","name":"number"}},{"id":5,"name":"warn","kind":1024,"kindString":"Property","flags":{"isExported":true},"comment":{"shortText":"Log warnings messages or above."},"sources":[{"fileName":"aurelia-logging.d.ts","line":20,"character":6}],"type":{"type":"instrinct","name":"number"}}],"groups":[{"title":"Properties","kind":1024,"children":[7,4,6,3,5]}],"sources":[{"fileName":"aurelia-logging.d.ts","line":5,"character":33}]},{"id":54,"name":"logLevel","kind":32,"kindString":"Variable","flags":{"isExported":true},"comment":{"shortText":"Specifies the available logging levels."},"sources":[{"fileName":"aurelia-logging.d.ts","line":82,"character":29}],"type":{"type":"reference","name":"LogLevel","id":2}},{"id":58,"name":"addAppender","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":59,"name":"addAppender","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Adds an appender capable of processing logs and channeling them to an output."},"parameters":[{"id":60,"name":"appender","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An appender instance to begin processing logs with.\n"},"type":{"type":"reference","name":"Appender","id":10}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":102,"character":35}]},{"id":68,"name":"addCustomLevel","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":69,"name":"addCustomLevel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Adds a custom log level that will be added as an additional method to Logger.\nLogger will call the corresponding method on any appenders that support it."},"parameters":[{"id":70,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name for the new log level."},"type":{"type":"instrinct","name":"string"}},{"id":71,"name":"value","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The numeric severity value for the level (higher is more severe).\n"},"type":{"type":"instrinct","name":"number"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":127,"character":38}]},{"id":66,"name":"clearAppenders","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":67,"name":"clearAppenders","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes all appenders."},"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":118,"character":38}]},{"id":64,"name":"getAppenders","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":65,"name":"getAppenders","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets an array of all appenders."},"type":{"type":"instrinct","name":"any"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":113,"character":36}]},{"id":78,"name":"getLevel","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":79,"name":"getLevel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the level of logging of ALL the application loggers.","returns":"The logLevel value used in all loggers.\n"},"type":{"type":"instrinct","name":"number"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":147,"character":32}]},{"id":55,"name":"getLogger","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":56,"name":"getLogger","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Gets the instance of a logger associated with a particular id (or creates one if it doesn't already exist).","returns":"The instance of the logger, or creates a new logger if none exists for that id.\n"},"parameters":[{"id":57,"name":"id","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The id of the logger you wish to get an instance of."},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"reference","name":"Logger","id":27}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":90,"character":33}]},{"id":61,"name":"removeAppender","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":62,"name":"removeAppender","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes an appender."},"parameters":[{"id":63,"name":"appender","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"An appender that has been added previously.\n"},"type":{"type":"reference","name":"Appender","id":10}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":108,"character":38}]},{"id":72,"name":"removeCustomLevel","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":73,"name":"removeCustomLevel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Removes a custom log level."},"parameters":[{"id":74,"name":"name","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"The name of a custom log level that has been added previously.\n"},"type":{"type":"instrinct","name":"string"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":133,"character":41}]},{"id":75,"name":"setLevel","kind":64,"kindString":"Function","flags":{"isExported":true},"signatures":[{"id":76,"name":"setLevel","kind":4096,"kindString":"Call signature","flags":{},"comment":{"shortText":"Sets the level of logging for ALL the application loggers."},"parameters":[{"id":77,"name":"level","kind":32768,"kindString":"Parameter","flags":{},"comment":{"text":"Matches a value of logLevel specifying the level of logging.\n"},"type":{"type":"instrinct","name":"number"}}],"type":{"type":"instrinct","name":"void"}}],"sources":[{"fileName":"aurelia-logging.d.ts","line":140,"character":32}]}],"groups":[{"title":"Classes","kind":128,"children":[27]},{"title":"Interfaces","kind":256,"children":[10,2]},{"title":"Variables","kind":32,"children":[54]},{"title":"Functions","kind":64,"children":[58,68,66,64,78,55,61,72,75]}]}