https://github.com/austinksmith/birler.js
100% Vanilla Javascript Searchable Logging System
https://github.com/austinksmith/birler.js
log-system logging logging-library
Last synced: 5 months ago
JSON representation
100% Vanilla Javascript Searchable Logging System
- Host: GitHub
- URL: https://github.com/austinksmith/birler.js
- Owner: austinksmith
- License: artistic-2.0
- Created: 2018-12-26T21:41:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-11T03:49:09.000Z (over 1 year ago)
- Last Synced: 2025-07-11T14:08:00.693Z (6 months ago)
- Topics: log-system, logging, logging-library
- Language: JavaScript
- Homepage:
- Size: 32.9 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Birler.js
**Author**: Austin K. Smith
**Website**: [Github](https://github.com/austinksmith/Birler.js)
**Description**: 100% Vanilla Javascript Searchable Logging System
**License**: Artistic License 2.0
# About
A useful isomorphic searchable logging system, saves results in memory for later lookup. Originally written for use with [Hamsters.js](http://www.hamsters.io) now moved into it's own package for reusability.
# Install
* Add Birler.js to your project using the instructions below
## HTML
* Download a copy of the library and add it to your webserver public directory
* Add script tag to your html page
```html
<!-- HTML5 -->
<script src="path/to/birler.web.min.js">
```
## Node
* Use npm install to add the project to your dependencies `npm install --save birler`
* Require the npm module in your app.js file
```js
var birler = require('birler.js');
```
## Once you've installed Birler.js you should now be able to run the following methods.
* INFO - Creates and saves info log event to log book with timestamp
```js
birler.info('New information log'); -> `Birler.js v1.0.0 INFO: New information log @ 198204829382`
```
* ERROR - Creates and saves error log event to log book with timestamp
```js
birler.error('New error log'); -> `Birler.js v1.0.0 ERROR: New error log @ 198204829382`
```
* WARNING - Creates and warning info log event to log book with timestamp
```js
birler.warning('New warning log'); -> `Birler.js v1.0.0 WARNING: New warning log @ 198204829382`
```
* getLogEntries - Returns logbook object containing all saved log entries
```js
birler.getLogEntries(); -> {info: [], warning: [], error: []}
```
* searchLogEntries - Searches saved log entries for search string, eventType optional
```js
birler.searchLogEntries(searchString, eventType);
```