# mocklogs

> mocks console.log()

Latest version **0.1.5** (published 2025-04-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install mocklogs
pnpm add mocklogs
yarn add mocklogs
bun add mocklogs
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2025-04-17 |
| First published | 2023-04-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | daniderodrigues |

## Links

- npm: https://www.npmjs.com/package/mocklogs
- Repository: https://github.com/dr-aiuta/loggermock
- Homepage: https://github.com/dr-aiuta/loggermock#readme
- Issues: https://github.com/dr-aiuta/loggermock/issues
- npm.io page: https://npm.io/package/mocklogs

## Recent versions

- 0.1.5 (latest) — 2025-04-17
- 0.1.4 — 2025-01-30
- 0.1.3 — 2025-01-30
- 0.1.2 — 2025-01-30
- 0.1.1 — 2025-01-30
- 0.0.3 — 2023-04-27
- 0.0.2 — 2023-04-27
- 0.0.1 — 2023-04-27

## README

# loggermock

A flexible and type-safe mock logger for testing and development with colored console output.

## Installation

```bash
npm install loggermock
```

## Features

- Type-safe logging interface
- Colored console output for different log levels
- Automatic caller information tracking
- Environment-aware logging (development/production)
- Timestamp support
- Zero dependencies

## Usage

```typescript
import { loggerMock } from "loggermock";

// Basic usage
loggerMock.info({
  message: ["User logged in", { userId: "123" }],
});

// Force logging even in production
loggerMock.debug({
  message: ["Debug information"],
  forceLog: true,
});

// Custom method name
loggerMock.error({
  message: ["Operation failed", new Error("Database error")],
  method: "CustomMethod",
});
```

## API

### LogOptions Interface

```typescript
interface LogOptions {
  forceLog?: boolean; // Force logging even in production
  method?: string; // Optional method name (auto-detected if not provided)
  message: (string | number | boolean | object)[]; // Message content
}
```

### Methods

Each method accepts a `LogOptions` object:

- `debug(options: LogOptions): void` - Blue colored debug messages
- `info(options: LogOptions): void` - Green colored info messages
- `warn(options: LogOptions): void` - Yellow colored warning messages
- `error(options: LogOptions): void` - Red colored error messages
- `log(options: LogOptions): void` - Standard log messages

### Output Format

The logger outputs messages in the following format:

```
[TIMESTAMP] [LEVEL] filename:method:line - message content
```

### Environment Behavior

- Development: All messages are logged by default
- Production: Messages are only logged when `forceLog: true`

## Examples

### Basic Usage

```typescript
import { loggerMock } from "loggermock";

// Debug with object data
loggerMock.debug({
  message: ["Processing request", { method: "GET", path: "/users" }],
});

// Warning with custom method
loggerMock.warn({
  message: ["Rate limit approaching"],
  method: "RateLimiter",
});

// Error with error object
loggerMock.error({
  message: ["Failed to connect", new Error("Connection timeout")],
});
```

## License

MIT

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

---
_Source: https://npm.io/package/mocklogs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
