[READ-ONLY] Mirror of https://github.com/FoxxMD/logging. A typed, opinionated, batteries-included, Pino-based logging solution for backend TS/JS projects
foxxmd.github.io/logging
child-logger
logging
logging-library
nodejs
pinojs
typescript-library
docs: Remove unnecessary file log options docs
It's already linked and contains the same/better info in typedoc page
+1
-62
+1
-62
README.md
+1
-62
README.md
···
124
124
});
125
125
```
126
126
127
-
### File Options
128
-
129
-
[`file` in `LogOptions`](https://foxxmd.github.io/logging/interfaces/index.FileLogOptions.html) may be an object that specifies more behavior log files.
130
-
131
-
<details>
132
-
133
-
<summary>File Options</summary>
134
-
135
-
```ts
136
-
export interface FileOptions {
137
-
/**
138
-
* The path and filename to use for log files.
139
-
*
140
-
* If using rolling files the filename will be appended with `.N` (a number) BEFORE the extension based on rolling status.
141
-
*
142
-
* May also be specified using env LOG_PATH or a function that returns a string.
143
-
*
144
-
* If path is relative the absolute path will be derived from the current working directory.
145
-
*
146
-
* @default 'CWD/logs/app.log'
147
-
* */
148
-
path?: string | (() => string)
149
-
/**
150
-
* For rolling log files
151
-
*
152
-
* When
153
-
* * value passed to rolling destination is a string (`path` option) and
154
-
* * `frequency` is defined
155
-
*
156
-
* This determines the format of the datetime inserted into the log file name:
157
-
*
158
-
* * `unix` - unix epoch timestamp in milliseconds
159
-
* * `iso` - Full ISO8601 datetime IE '2024-03-07T20:11:34-00:00'
160
-
* * `auto`
161
-
* * When frequency is `daily` only inserts date IE YYYY-MM-DD
162
-
* * Otherwise inserts full ISO8601 datetime
163
-
*
164
-
* @default 'auto'
165
-
* */
166
-
timestamp?: 'unix' | 'iso' | 'auto'
167
-
/**
168
-
* The maximum size of a given rolling log file.
169
-
*
170
-
* Can be combined with frequency. Use k, m and g to express values in KB, MB or GB.
171
-
*
172
-
* Numerical values will be considered as MB.
173
-
* */
174
-
size?: number | string
175
-
/**
176
-
* The amount of time a given rolling log file is used. Can be combined with size.
177
-
*
178
-
* Use `daily` or `hourly` to rotate file every day (or every hour). Existing file within the current day (or hour) will be re-used.
179
-
*
180
-
* Numerical values will be considered as a number of milliseconds. Using a numerical value will always create a new file upon startup.
181
-
*
182
-
* @default 'daily'
183
-
* */
184
-
frequency?: 'daily' | 'hourly' | number
185
-
}
186
-
```
187
-
188
-
</details>
127
+
[`file` in `LogOptions`](https://foxxmd.github.io/logging/interfaces/index.FileLogOptions.html) may also be an object that specifies more behavior.
189
128
190
129
### Additional App Logger Configuration
191
130