Liking cljdoc? Tell your friends :D

dots.node.fs.stats

A fs.Stats object provides information about a file.

Objects returned from {@link stat }, {@link lstat }, {@link fstat }, and their synchronous counterparts are of this type. If bigint in the options passed to those methods is true, the numeric values will be bigint instead of number, and the object will contain additional nanosecond-precision properties suffixed with Ns.

Stats {
  dev: 2114,
  ino: 48064969,
  mode: 33188,
  nlink: 1,
  uid: 85,
  gid: 100,
  rdev: 0,
  size: 527,
  blksize: 4096,
  blocks: 8,
  atimeMs: 1318289051000.1,
  mtimeMs: 1318289051000.1,
  ctimeMs: 1318289051000.1,
  birthtimeMs: 1318289051000.1,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT }

bigint version:

BigIntStats {
  dev: 2114n,
  ino: 48064969n,
  mode: 33188n,
  nlink: 1n,
  uid: 85n,
  gid: 100n,
  rdev: 0n,
  size: 527n,
  blksize: 4096n,
  blocks: 8n,
  atimeMs: 1318289051000n,
  mtimeMs: 1318289051000n,
  ctimeMs: 1318289051000n,
  birthtimeMs: 1318289051000n,
  atimeNs: 1318289051000000000n,
  mtimeNs: 1318289051000000000n,
  ctimeNs: 1318289051000000000n,
  birthtimeNs: 1318289051000000000n,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT }
A `fs.Stats` object provides information about a file.

Objects returned from {@link stat }, {@link lstat }, {@link fstat }, and
their synchronous counterparts are of this type.
If `bigint` in the `options` passed to those methods is true, the numeric values
will be `bigint` instead of `number`, and the object will contain additional
nanosecond-precision properties suffixed with `Ns`.

```console
Stats {
  dev: 2114,
  ino: 48064969,
  mode: 33188,
  nlink: 1,
  uid: 85,
  gid: 100,
  rdev: 0,
  size: 527,
  blksize: 4096,
  blocks: 8,
  atimeMs: 1318289051000.1,
  mtimeMs: 1318289051000.1,
  ctimeMs: 1318289051000.1,
  birthtimeMs: 1318289051000.1,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT }
```

`bigint` version:

```console
BigIntStats {
  dev: 2114n,
  ino: 48064969n,
  mode: 33188n,
  nlink: 1n,
  uid: 85n,
  gid: 100n,
  rdev: 0n,
  size: 527n,
  blksize: 4096n,
  blocks: 8n,
  atimeMs: 1318289051000n,
  mtimeMs: 1318289051000n,
  ctimeMs: 1318289051000n,
  birthtimeMs: 1318289051000n,
  atimeNs: 1318289051000000000n,
  mtimeNs: 1318289051000000000n,
  ctimeNs: 1318289051000000000n,
  birthtimeNs: 1318289051000000000n,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT }
```
raw docstring

atimecljs

(atime stats)
source

atime-mscljs

(atime-ms stats)
source

birthtimecljs

(birthtime stats)
source

birthtime-mscljs

(birthtime-ms stats)
source

blksizecljs

(blksize stats)
source

block-device?cljs

(block-device? stats)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

blockscljs

(blocks stats)
source

character-device?cljs

(character-device? stats)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

ctimecljs

(ctime stats)
source

ctime-mscljs

(ctime-ms stats)
source

devcljs

(dev stats)
source

directory?cljs

(directory? stats)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

fifo?cljs

(fifo? stats)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

file?cljs

(file? stats)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

gidcljs

(gid stats)
source

inocljs

(ino stats)
source

modecljs

(mode stats)
source

mtimecljs

(mtime stats)
source

mtime-mscljs

(mtime-ms stats)
source

(nlink stats)
source

rdevcljs

(rdev stats)
source

set-atime!cljs

(set-atime! stats value)
source

set-atime-ms!cljs

(set-atime-ms! stats value)
source

set-birthtime!cljs

(set-birthtime! stats value)
source

set-birthtime-ms!cljs

(set-birthtime-ms! stats value)
source

set-blksize!cljs

(set-blksize! stats value)
source

set-blocks!cljs

(set-blocks! stats value)
source

set-ctime!cljs

(set-ctime! stats value)
source

set-ctime-ms!cljs

(set-ctime-ms! stats value)
source

set-dev!cljs

(set-dev! stats value)
source

set-gid!cljs

(set-gid! stats value)
source

set-ino!cljs

(set-ino! stats value)
source

set-mode!cljs

(set-mode! stats value)
source

set-mtime!cljs

(set-mtime! stats value)
source

set-mtime-ms!cljs

(set-mtime-ms! stats value)
source

set-nlink!cljs

(set-nlink! stats value)
source

set-rdev!cljs

(set-rdev! stats value)
source

set-size!cljs

(set-size! stats value)
source

set-uid!cljs

(set-uid! stats value)
source

sizecljs

(size stats)
source

socket?cljs

(socket? stats)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

symbolic-link?cljs

(symbolic-link? stats)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

uidcljs

(uid stats)
source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close