Skip to content

Commit

Permalink
✏️ improve API text
Browse files Browse the repository at this point in the history
  • Loading branch information
astoilkov committed Jan 8, 2024
1 parent a97128a commit f2ce4df
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,40 +110,48 @@ Inspects a value. Great for debugging. Similar to `util.inspect()`. A substitute

##### `ConsoleInspectOptions.expandDepth`

Type: `number`
Type: `number`
Default: `2`

How much levels to expand the object. Levels after that will be collapsed.

##### `ConsoleInspectOptions.indent`

Type: `number`
Type: `number`
Default: `4`

How much spaces to add when going down a level.

##### `ConsoleInspectOptions.theme`

Type: `'light' | 'dark'`
Type: `'light' | 'dark'`
Default: automatically determined based on the system theme.

Determines the colors that will be used to style the output.

##### `ConsoleInspectOptions.print`

Type: `boolean`
Type: `boolean`
Default: `true`

If set to `false`, the method won't print to the console. In this case, you probably want to get the return value of the method and use it.

#### `consoleTable(value: object, options: ConsoleTableOptions): ConsoleSpan[]`

##### `ConsoleTableOptions.theme`

Type: `'light' | 'dark'`
Type: `'light' | 'dark'`
Default: automatically determined based on the system theme.

Determines the colors that will be used to style the output.

##### `ConsoleTableOptions.print`

Type: `boolean`
Type: `boolean`
Default: `true`

If set to `false`, the method won't print to the console. In this case, you probably want to get the return value of the method and use it.

## API _(core)_

#### `consolePrint(spans: ConsoleSpan[]): void`
Expand Down

0 comments on commit f2ce4df

Please sign in to comment.