logixlysia 6.0.0 → 6.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +49 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<h1><code>🦊</code> Logixlysia</h1>
|
|
3
|
+
<strong>Logixlysia is a logging library for ElysiaJS</strong>
|
|
4
|
+
<img src="./apps/docs/app/opengraph-image.png" alt="Logixlysia" width="100%" height="auto" />
|
|
5
|
+
</div>
|
|
6
|
+
|
|
7
|
+
## `📩` Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
bun add logixlysia
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## `📝` Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { Elysia } from 'elysia'
|
|
17
|
+
import logixlysia from 'logixlysia' // or import { logixlysia } from 'logixlysia'
|
|
18
|
+
|
|
19
|
+
const app = new Elysia({
|
|
20
|
+
name: "Elysia with Logixlysia"
|
|
21
|
+
})
|
|
22
|
+
.use(
|
|
23
|
+
logixlysia({
|
|
24
|
+
config: {
|
|
25
|
+
showStartupMessage: true,
|
|
26
|
+
startupMessageFormat: 'simple',
|
|
27
|
+
timestamp: {
|
|
28
|
+
translateTime: 'yyyy-mm-dd HH:MM:ss.SSS'
|
|
29
|
+
},
|
|
30
|
+
logFilePath: './logs/example.log',
|
|
31
|
+
ip: true,
|
|
32
|
+
customLogFormat:
|
|
33
|
+
'🦊 {now} {level} {duration} {method} {pathname} {status} {message} {ip}'
|
|
34
|
+
}
|
|
35
|
+
}))
|
|
36
|
+
.get('/', () => {
|
|
37
|
+
return { message: 'Welcome to Basic Elysia with Logixlysia' }
|
|
38
|
+
})
|
|
39
|
+
|
|
40
|
+
app.listen(3000)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## `📚` Documentation
|
|
44
|
+
|
|
45
|
+
Check out the [website](https://logixlysia.vercel.app) for more detailed documentation and examples.
|
|
46
|
+
|
|
47
|
+
## `📄` License
|
|
48
|
+
|
|
49
|
+
Licensed under the [MIT License](LICENSE).
|