cljs-node-io.core — com.github.pkpkpk/cljs-node-io 2.0.339

acopy cljs

(acopy input output & opts)

Copies input to output via streams asynchronously.

• Unlike JVM, strings interpreted as filespaths
• Options are passed to the output stream. @param {(string, File, Buffer, Readable)} input @param {(string, File, Buffer, Readable)} output @return {!Channel} yielding [?err]

as-relative-path cljs

(as-relative-path x)

a relative path, else IllegalArgumentException. @param {(string|IFile|Uri)} x @return {!string}

aslurp cljs

(aslurp p & opts)

@return {!Channel} a which will receive [?err ?data]

aspit cljs

(aspit p content & options)

Async spit. Wait for result before writing again! @param {(string|IFile|Uri)} p :: path to write to @param {(string|buffer.Buffer)} content to write Options: :encoding {string} defaults to utf8. Ignored when content is a buffer :append {bool} - add content to end of existing file. :flags {string} - overrides :append when set :mode {number} - set on newly created files @return {!Channel} recieves [?err]

buffer? cljs

Buffer? cljs

(Buffer? b)

sugar over Buffer.isBuffer @param {*} b @return {!boolean}

Coercions cljs protocol

as-file cljs

(as-file x)

Coerce argument to a file.

as-url cljs

(as-url x)

Coerce argument to a URL.

copy cljs

(copy input output & opts)

Synchronously copies input to output.. Only supports files and strings/buffers as filepaths @param {(string, File, Buffer)} input @param {(string, File, Buffer)} output @return {nil} throws on error

delete-file cljs

(delete-file f & [silently])

Delete file f. Raise an exception if it fails unless silently is true. @return {!boolean}

file cljs

(file arg)

(file parent child)

(file parent child & more)

Returns a reified file, passing each arg to as-file. Multiple-arg versions treat the first argument as parent and subsequent args as children relative to the parent. Use in place of File constructor @return {!IFile}

file-seq cljs

(file-seq dir)

A tree seq on cljs-node-io.Files @return {LazySeq<File>}

filepath cljs

(filepath a)

(filepath a b)

This is needed to mock the java.io.File constructor. The java File constructor is polymorphic and accepts one or two args: (Uri), (pathstring), (parentstring, childstring), (File, childstring) @return {!string}

fs cljs

input-stream cljs

(input-stream x & opts)

Attempt to create a native stream.Readable. {@link https://nodejs.org/api/stream.html#class-streamreadable} Note that node streams are event driven.

• stream.Readable => itself
• buffers => stream.Readable
• files + strings + goog.Uri => fs.ReadStream @return {!stream.Readable}

IOFactory cljs protocol

Attempts to create a native node stream.

make-input-stream cljs

(make-input-stream x opts)

create stream.Readable

make-output-stream cljs

(make-output-stream x opts)

create stream.Writable

make-reader cljs

(make-reader x opts)

create stream.Readable

make-writer cljs

(make-writer x opts)

create stream.Writable

make-parents cljs

(make-parents f & more)

Given the same arg(s) as for file, creates all parent directories of the file they represent. @return {!boolean}

output-stream cljs

(output-stream x & opts)

Attempt to create a native stream.Writable. {@link https://nodejs.org/api/stream.html#class-streamwritable} Note that node streams are event driven.

• stream.Writable => itself
• buffers => stream.Writable
• files + strings + goog.Uri => fs.WriteStream @return {!stream.Writable}

path cljs

readable cljs

(readable obj)

(readable obj opts)

Tries to create a stream.Readable from obj. Supports iterables & array-likes in addition to those types supported by IOFactory {@link https://nodejs.org/api/stream.html#class-streamreadable} @param {*} obj @return {!stream.Readable}

reader cljs

(reader x & opts)

Attempt to create a native stream.Readable. {@link https://nodejs.org/api/stream.html#class-streamreadable} Note that node streams are event driven.

• stream.Readable => itself
• buffers => stream.Readable
• files + strings + goog.Uri => fs.ReadStream @return {!stream.Readable}

slurp cljs

(slurp p & opts)

Returns a string synchronously. Unlike JVM, does not use FileInputStream. Only option at this time is :encoding If :encoding "" (an explicit empty string), returns raw buffer instead of string. @return {(string|buffer.Buffer)}

spit cljs

(spit p content & options)

Writes content synchronously to file f. @param {(string|IFile|Uri)} p :: path to write to @param {(string|buffer.Buffer)} content to write Options: :encoding {string} defaults to utf8. Ignored when content is a buffer :append {bool} - add content to end of existing file. :flags {string} - overrides :append when set :mode {number} - set on newly created files @return {nil} or throws

stream cljs

writable cljs

(writable obj)

(writable obj opts)

Tries to create a stream.Writable from obj @param {*} obj @return {!stream.Writable}

writer cljs

(writer x & opts)

Attempt to create a native stream.Writable. {@link https://nodejs.org/api/stream.html#class-streamwritable} Note that node streams are event driven.

• stream.Writable => itself
• buffers => stream.Writable
• files + strings + goog.Uri => fs.WriteStream @return {!stream.Writable}