XPR-API.MD

XPR Overview

Here is an SDK Snapshot of the current XPR API:

XPR.matchSDKs("\\S")

[
  "XPR.appendTextFile: f:(FilePath file, String output, CharSet encoding) => void",
  "XPR.base64ToBuffer: f:(String source) => Buffer",
  "XPR.bufferBytesTotal: f:() => long",
  "XPR.bufferCount: f:() => long",
  "XPR.bufferFromArrayBuffer: f:(ArrayBuffer transferShare) => Buffer",
  "XPR.bufferLength: f:(Buffer buffer) => long",
  "XPR.bufferToArrayBuffer: f:(Buffer transferOut) => ArrayBuffer",
  "XPR.bufferToBase64: f:(Buffer transferOut) => String",
  "XPR.bufferToDigestMD5: f:(Buffer buffer) => String",
  "XPR.bufferToInputStream: f:(Buffer transferOut) => Stream",
  "XPR.bufferToString: f:(Buffer transferOut, CharSet encoding) => String",
  "XPR.canExecute: f:(FilePath file) => boolean",
  "XPR.canRead: f:(FilePath file) => boolean",
  "XPR.canWrite: f:(FilePath file) => boolean",
  "XPR.changeDirectory: f:(FilePath directory) => void",
  "XPR.closeStream: f:(Stream stream) => void",
  "XPR.copyBufferOutputStreamBytes: f:(Stream bufferOutputStream) => Buffer",
  "XPR.copyFile: f:(FilePath source, FilePath destination) => boolean",
  "XPR.createBuffer: f:(int width, int length) => Buffer",
  "XPR.createBufferOutputStream: f:(int bytes) => Stream",
  "XPR.createDirectory: f:(FilePath file) => boolean",
  "XPR.createFile: f:(FilePath file) => boolean",
  "XPR.currentDirectory: f:() => FilePath",
  "XPR.deleteEnvironmentKey: f:(String key) => void",
  "XPR.deleteFile: f:(FilePath file) => boolean",
  "XPR.directoryPath: f:(FilePath file) => boolean",
  "XPR.existingFile: f:(FilePath file) => boolean",
  "XPR.fileCreateTime: f:(FilePath file) => EpochTime",
  "XPR.fileName: f:(FilePath file) => String",
  "XPR.fileOwnership: f:(FilePath file) => String",
  "XPR.fileParent: f:(FilePath file) => String",
  "XPR.fileSize: f:(FilePath file) => long",
  "XPR.fileWritableSpace: f:(FilePath file) => long",
  "XPR.fileWriteTime: f:(FilePath file) => EpochTime",
  "XPR.freeBuffer: f:(Buffer buffer) => void",
  "XPR.getCharSet: f:() => CharSet",
  "XPR.getEnvironmentKey: f:(String key) => String",
  "XPR.getEnvironmentKeys: f:(int spacing) => JSONArray",
  "XPR.getFileMode: f:(FilePath file) => int",
  "XPR.getFilePermissions: f:(FilePath file) => String",
  "XPR.getFileSeparator: f:() => String",
  "XPR.getFileUri: f:(FilePath file) => FilePath",
  "XPR.getInputStreamBytesReady: f:(Stream stream) => int",
  "XPR.getLineSeparator: f:() => String",
  "XPR.getParameter: f:(int parameter) => String",
  "XPR.getParameterCount: f:() => int",
  "XPR.getParameters: f:(int spacing) => JSONArray",
  "XPR.getPathSeparator: f:() => String",
  "XPR.getRealFile: f:(FilePath file) => FilePath",
  "XPR.getSDK: f:(String xprFunctionPath) => String",
  "XPR.getStandardErrorStream: f:() => Stream",
  "XPR.getStandardInputStream: f:() => Stream",
  "XPR.getStandardOutputStream: f:() => Stream",
  "XPR.getStreamType: f:(Stream stream) => String",
  "XPR.getSystemArchitecture: f:() => String",
  "XPR.getSystemCharSet: f:() => CharSet",
  "XPR.getSystemCharSets: f:(int jsonSpacing) => JSONArray",
  "XPR.getSystemType: f:() => String",
  "XPR.getSystemVersion: f:() => String",
  "XPR.getUserHome: f:() => String",
  "XPR.getUserName: f:() => String",
  "XPR.hiddenFile: f:(FilePath file) => boolean",
  "XPR.inputStreamToBuffer: f:(Stream transferOut) => Buffer",
  "XPR.listFiles: f:(FilePath file, int spacing) => JSONArray",
  "XPR.matchFiles: f:(FilePath file, String regEx, String regExModifier) => String",
  "XPR.matchSDKs: f:(String regEx, String regExModifier) => JSONArray",
  "XPR.moveFile: f:(FilePath source, FilePath destination) => boolean",
  "XPR.normalFile: f:(FilePath file) => boolean",
  "XPR.openFileInputStream: f:(Stream stream) => Stream",
  "XPR.openFileOutputStream: f:(Stream stream) => Stream",
  "XPR.print: f:(String output, CharSet encoding) => void",
  "XPR.printError: f:(String output, CharSet encoding) => void",
  "XPR.printErrorLine: f:(String output, CharSet encoding) => void",
  "XPR.printLine: f:(String output, CharSet encoding) => void",
  "XPR.readInputStream: f:(Stream stream, Buffer buffer) => int",
  "XPR.readLine: f:(CharSet encoding) => String",
  "XPR.readTextFile: f:(FilePath file, CharSet encoding) => String",
  "XPR.relativeFile: f:(FilePath file) => boolean",
  "XPR.resetStandardStreams: f:() => void",
  "XPR.run: f:(FilePath command, JSONObject options) => JSONObject",
  "XPR.setCharSet: f:(CharSet encoding, boolean validated) => void",
  "XPR.setEnvironmentKey: f:(String key, String value) => void",
  "XPR.setFileMode: f:(FilePath file, int mode) => int",
  "XPR.setFilePermissions: f:(FilePath file, String permissions) => void",
  "XPR.setJsonSpacing: f:(int spacing) => void",
  "XPR.setStandardErrorStream: f:(Stream outputStream, CharSet encoding) => boolean",
  "XPR.setStandardInputStream: f:(Stream inputStream) => boolean",
  "XPR.setStandardOutputStream: f:(Stream outputStream, CharSet encoding) => boolean",
  "XPR.sliceBuffer: f:(Buffer buffer, int offset, int length) => Buffer",
  "XPR.stringToBuffer: f:(String source, CharSet encoding) => Buffer",
  "XPR.updateFile: f:(FilePath source, FilePath destination) => boolean",
  "XPR.writeOutputStream: f:(Stream stream, Buffer buffer, boolean flush) => void",
  "XPR.writeTextFile: f:(FilePath file, String output, CharSet encoding) => void"
]

Note:

This file was generated during the krypton build process, by krypton; post-build.

These APIs should be considered conceptual, unless such API is found within XPR's Help Browser.