Skip to main content

truncate

function truncate
Jump to headingtruncate(
path: PathLike,
len:
number
| undefined
| null
,
callback: NoParamCallback,
): void

Truncates the file. No arguments other than a possible exception are given to the completion callback. A file descriptor can also be passed as the first argument. In this case, fs.ftruncate() is called.

import { truncate } from 'node:fs';
// Assuming that 'path/file.txt' is a regular file.
truncate('path/file.txt', (err) => {
  if (err) throw err;
  console.log('path/file.txt was truncated');
});

Passing a file descriptor is deprecated and may result in an error being thrown in the future.

See the POSIX truncate(2) documentation for more details.

Parameters Jump to heading

optional
Jump to headinglen:
number
| undefined
| null
= 0

Return Type Jump to heading

void
Jump to headingtruncate(
path: PathLike,
callback: NoParamCallback,
): void

Asynchronous truncate(2) - Truncate a file to a specified length.

Parameters Jump to heading

A path to a file. If a URL is provided, it must use the file: protocol.

Return Type Jump to heading

void
Back to top