1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
Cordova File Logger
==========
[](http://bower.io/search/?q=filelogger)
Logger module for Cordova/Ionic projects.
When you run your application in device the Logger writes in the local filesystem (with cordova-plugin-file) and the system logs (with console.log).
When you run your application in browser with „ionic serve” the Logger uses browsers localStorage and the browser console (with console.log).
## Dependencies
- [ngCordova](http://ngcordova.com/) ( required version v0.1.14-alpha )
- [org.apache.cordova.file](https://github.com/apache/cordova-plugin-file)
## Installation
Install manually, or from bower:
```bash
$ bower install filelogger
```
Include *filelogger.min.js* and ng-cordova.js or *ng-cordova.min.js* in your index.html file before cordova.js and after your AngularJS / Ionic file (since ngCordova depends on AngularJS).
```html
<script src="lib/ngCordova/dist/ng-cordova.min.js"></script>
<script src="lib/filelogger/dist/filelogger.min.js"></script>
<script src="cordova.js"></script>
```
Comment: you don't have to use the complete ngCordova package. I suggest to create a [Custom Build](http://ngcordova.com/build/) with file module.
## Usage
### $fileLogger.log()
General logger method. The first parameter is the log level (debug, info, warn, error). The following parameters are the message parts.
You can put here any javascript type (string, number, boolean, object, array).
In the logfile every item starts with the current UTC timestamp, followed by the log level and the message.
### $fileLogger.debug()
Wrapper for $fileLogger.log('debug', ...)
### $fileLogger.info()
Wrapper for $fileLogger.log('info', ...)
### $fileLogger.warn()
Wrapper for $fileLogger.log('warn', ...)
### $fileLogger.error()
Wrapper for $fileLogger.log('error', ...)
### $fileLogger.setStorageFilename()
You can set the local filename (default messages.log). It requests one parameter, the filename (type string).
### $fileLogger.getLogfile()
You can read the whole logfile from the filestore. This method returns a promise.
### $fileLogger.deleteLogfile()
You can delete the logfile from the filestore. This method returns a promise.
### Example use
```js
angular.module('starter', ['ionic', 'fileLogger'])
.controller('mainCtrl', ['$scope', '$fileLogger', function($scope, $fileLogger) {
function testing() {
$fileLogger.setStorageFilename('myLog.txt');
$fileLogger.log('debug', 'message');
$fileLogger.log('info', 'message');
$fileLogger.log('warn', 'message');
$fileLogger.log('error', 'message');
$fileLogger.debug('message');
$fileLogger.info('message');
$fileLogger.warn('message');
$fileLogger.error('message');
$fileLogger.log('error', 'error message', { code: 1, meaning: 'general' });
$fileLogger.log('info', 'message', 123, [1, 2, 3], { a: 1, b: '2' });
$fileLogger.getLogfile().then(function(l) {
console.log('Logfile content');
console.log(l);
});
$fileLogger.deleteLogfile().then(function() {
console.log('Logfile deleted');
});
}
}]);
```
## Author
#### Peter Bakondy
- https://github.com/pbakondy
## LICENSE
Cordova File Logger is licensed under the MIT Open Source license. For more information, see the LICENSE file in this repository.
|
