Skip to content

Latest commit

 

History

History
956 lines (952 loc) · 72.6 KB

SPEC.md

File metadata and controls

956 lines (952 loc) · 72.6 KB
Raw

Specification

Export Path

Export Tree

  • Browser
    • Canvas
      • Font
        • createFontGenerator, createFontGeneratorBitmap, createFontMapper, createFontRender, createFontRenderBitmap
      • Color
        • hexCSSFromRgb, hexCSSFromRgba, rgbaFromUint32, uint32FromRgba
      • ImageData
        • applyCanvasElementExt, applyCanvasImageDataExt, applyImageElementExt, canvasElementToCanvasImageData, canvasImageDataToCanvasElement, createCanvasElement, createCanvasImageData, createImageElement, getQuickCanvas, getQuickContext2d, imageElementToCanvasElement, imageElementToCanvasImageData
      • ImageDataOperation
        • crop, drawPixel, drawPixelLine, drawPixelLineList, floodFill, getPixelColor, replacePixelColor, scale
      • Function
        • loadImage, loadText
    • Data
      • Blob
        • Blob, parseBlobAsArrayBuffer, parseBlobAsDataURL, parseBlobAsText
      • BlobPacket
        • packBlobPacket, parseBlobPacket
    • Input
      • EnhancedEventProcessor
        • createSwipeEnhancedEventProcessor
      • KeyCommand
        • createKeyCommandHub
      • PointerEvent
        • ENHANCED_POINTER_EVENT_TYPE, POINTER_EVENT_TYPE, applyEnhancedPointerEventListener, applyPointerEventListener
    • Module
      • FileChunkUpload
        • uploadFileByChunk
      • HistoryStateStore
        • createHistoryStateStore
      • LocalStorageStateStore
        • createLocalStorageStateStore
      • MotionAutoTimer
        • createInterpolationAutoTimer, createVectorAccumulator
    • DOM
      • applyReceiveFileListListener, createDownload, createDownloadWithBlob, createDownloadWithObject, createDownloadWithString, createElement, deleteArrayBufferCache, getElementAtViewport, getPathElementList, loadArrayBufferCache, saveArrayBufferCache, throttleByAnimationFrame
    • Net
      • fetchLikeRequest
  • Common
    • Data
      • ArrayBuffer
        • calcSHA256ArrayBuffer, concatArrayBuffer, deconcatArrayBuffer, fromNodejsBuffer, fromU16String, isEqualArrayBuffer, toU16String
      • ArrayBufferPacket
        • HEADER_BYTE_SIZE, MAX_PACKET_HEADER_SIZE, packArrayBufferHeader, packArrayBufferListPacket, packArrayBufferPacket, packArrayBufferPacket2, packChainArrayBufferPacket, parseArrayBufferHeader, parseArrayBufferListPacket, parseArrayBufferPacket, parseArrayBufferPacket2, parseChainArrayBufferPacket
      • B62
        • B62_MAX, B62_ZERO, decode, encode
      • B62S
        • B62S_MAX, B62S_ZERO, decode, encode
      • B86
        • B86_MAX, B86_ZERO, decode, encode
      • Base64
        • decode, encode
      • CacheMap
        • createCache, createCacheMap
      • CacheMap2
        • createCacheMap2
      • DataUri
        • decode, encode
      • F32
        • cast, decodeF32, decodeF32W, encodeF32, encodeF32W
      • Iter
        • createLockStepAsyncIter, unwrap, wrapAsync, wrapSync
      • LinkedList
        • createDoublyLinkedList, createNode
      • ListMap
        • createListMap
      • LoopIndex
        • createLoopIndex
      • MapMap
        • createMapMap, getInvertMapMap
      • SaveQueue
        • createSaveQueue
      • SetMap
        • createSetMap, getInvertSetMap
      • Toggle
        • createToggle
      • Tree
        • createTreeBottomUpSearch, createTreeBottomUpSearchAsync, createTreeBreadthFirstSearch, createTreeBreadthFirstSearchAsync, createTreeDepthFirstSearch, createTreeDepthFirstSearchAsync, prettyStringifyTreeNode
      • Tree2
        • SEARCH_END, SEARCH_SKIP, createTree2BottomUpSearch, createTree2BottomUpSearchAsync, createTree2BreadthFirstSearch, createTree2BreadthFirstSearchAsync, createTree2DepthFirstSearch, createTree2DepthFirstSearchAsync, prettyStringifyTree2Node
      • dupJSON, getValueByKeyList, hashStringToNumber, reverseString, swapObfuscateString, tryParseJSONObject
    • Geometry
      • D2
        • BoundingRect
          • fromEmpty, fromPoint, fromWidget, fromWidgetList, getCenter, getUnion, isContainPoint, isIntersect
        • Line
          • fromWidget
        • Rect
          • fromBoundingRect, fromEmpty, fromPoint, getCenter, getSize, getUnion, getUnionOfList, isContain, isContainPoint, isEmpty, isIntersect
        • Vector
          • abs, add, clamp, divide, fromAngleLength, fromOrigin, getAngle, getDist, getDistSq, getDotProduct, getLength, getLengthSq, getRotate, getRotateDelta, isZero, lerp, max, min, multiply, project, round, scale, sub
        • Widget
          • fromBoundingRect, fromLine, fromPoint, getBoundingBottom, getBoundingHeight, getBoundingLeft, getBoundingRight, getBoundingSize, getBoundingTop, getBoundingWidth, isContainBoundingRect, isInterceptBoundingRect, localBoundingRect, localPoint, round
      • Angle
        • DEGREE_TO_RADIAN, RADIAN_TO_DEGREE, fromDegree, getDegree
    • Immutable
      • Array
        • arrayConcat, arrayDelete, arrayFindDelete, arrayFindMove, arrayFindOrPush, arrayFindSet, arrayFindSetOrPush, arrayInsert, arrayMatchDelete, arrayMatchMove, arrayMatchPush, arrayMove, arrayPop, arrayPush, arraySet, arrayShift, arraySplitChunk, arrayUnshift
      • Object
        • objectDelete, objectFilter, objectFindKey, objectFromEntries, objectMap, objectMerge, objectPickKey, objectSet
      • StateStore
        • createEntryEnhancer, createStateStore, createStateStoreEnhanced, createStateStoreLite, createStoreStateSyncReducer, reducerFromMap, toReduxStore
      • isArrayShallowEqual, isCompactArrayShallowEqual, isObjectShallowEqual, transformCache
    • Math
      • addAbs, clamp, euclideanModulo, lerp, roundFloat, smoothstep, easeInCirc, easeInCubic, easeInExpo, easeInOutCirc, easeInOutCubic, easeInOutExpo, easeInOutQuad, easeInOutQuart, easeInOutQuint, easeInOutSine, easeInQuad, easeInQuart, easeInQuint, easeInSine, easeOutCirc, easeOutCubic, easeOutExpo, easeOutQuad, easeOutQuart, easeOutQuint, easeOutSine, linear, getRandomArrayBuffer, getRandomId, getRandomId62, getRandomId62S, getRandomInt, getRandomIntList, getSample, getSampleIterator, getSampleIteratorRange, getSampleIteratorRate, getSampleRange, getSampleRate
    • Module
      • AsyncFuncQueue
        • createAsyncFuncQueue
      • AsyncLane
        • createAsyncLane, extendAutoSelectByTagLane, extendAutoSelectLane, extendLaneValueList, extendLaneValueMap, selectByTagOrMinLoadLane, selectMinLoadLane
      • AsyncTask
        • ASYNC_TASK_KEY_MAP, ASYNC_TASK_PHASE_MAP, getAsyncTaskPhase, resetAsyncTask, runAsyncTask
      • AsyncTaskQueue
        • ASYNC_TASK_QUEUE_KEY_MAP, createAsyncTaskQueue, createFilterStaleAsyncTask
      • BlockChart
        • getBlockBar, getBlockChart
      • ChunkUpload
        • packArrayBufferChunk, parseArrayBufferChunk, uploadArrayBufferByChunk
      • Event
        • createEventEmitter, createEventTarget, createHub
      • Exot
        • createDummyExot, createExotError, createExotGroup, findExotMapValue, isExot, mapExotMapValue, toExotMap
      • HTML
        • COMMON_FUNC_MAP, COMMON_LAYOUT, COMMON_SCRIPT, COMMON_STYLE, simpleCompactCSS, styleTagMerge
      • KeySelector
        • concatKeyFrag, createMultiKeySwitch, reduceKeySelector
      • KeyTree
        • createKeyTree, createKeyTreeEnhanced
      • LevenshteinDistance
        • getLevenshteinDistance
      • MIME
        • BASIC_EXTENSION_MAP, DEFAULT_MIME, getMIMETypeFromFileName
      • PackageJSON
        • collectDependency, getFirstBinPath, packPackageJSON, parsePackageNameAndVersion, sortPackageJSON, toPackageInfo, toPackageTgzName
      • Patch
        • createPatchKit, toArrayWithKeyPatchKit, toObjectPatchKit
      • RouteMap
        • appendRouteMap, createRouteMap, findRouteFromMap, getRouteParam, getRouteParamAny, parseRouteToMap, parseRouteUrl
      • Runlet
        • ChipSyncBasic, END, KEY_PEND_INPUT, KEY_PEND_OUTPUT, KEY_POOL_IO, PoolIO, REDO, SKIP, TYPE_LOGICAL_PENDVIEW, TYPE_LOGICAL_PENDVIEWEE, clearPack, createCountPool, createLogicalCountPool, createPack, createRunlet, describePack, quickConfigPend, toChipMap, toLinearChipList, toPoolMap
      • RunletChip
        • createArrayInputChip, createArrayOutputChip, createAsyncIterInputChip, createAsyncIterOutputChip, createENDRegulatorChip
      • SemVer
        • compareSemVer, isVersionSpecComplex, packSemVer, parseSemVer, versionBumpByGitBranch, versionBumpLastNumber, versionBumpToIdentifier, versionBumpToLocal
      • TextEnDecoder
        • TextDecoder, TextEncoder, decodeUTF8, encodeUTF8
      • TimedLookup
        • generateCheckCode, generateLookupData, packCheckCode, packDataArrayBuffer, packDataArrayBuffer2, parseCheckCode, parseDataArrayBuffer, parseDataArrayBuffer2, verifyCheckCode, verifyOption, verifyParsedCheckCode
      • TimerTag
        • calcDate, packTimerTag, parseTimerTag
      • TupleHasherDev
        • createTupleHasher
      • UpdateLoop
        • createUpdateLoop, createUpdater
    • Mutable
      • Object
        • objectMergeDeep, objectSortKey
    • Check
      • isArrayBuffer, isArrayLength, isBasicArray, isBasicFunction, isBasicObject, isBoolean, isFunctionThrow, isFunctionThrowAsync, isInteger, isNumber, isObjectAlike, isObjectContain, isObjectKey, isOneOf, isPromiseAlike, isRegExp, isStrictEqual, isString, isStringifyEqual, isTruthy
    • Compare
      • compareString, compareStringLocale, compareStringWithNumber
    • Error
      • catchAsync, catchPromise, catchSync, remessageError, rethrowError, withFallbackResult, withFallbackResultAsync
    • Format
      • binary, decimal, describe, mediaTime, padTable, percent, prettyStringifyConfigObject, prettyStringifyJSON, time, typeNameOf
    • Function
      • createInsideOutPromise, debounce, debounceL, debounceT, loneAsync, lossyAsync, once, runAsPromise, runAsyncByLane, throttle, throttleL, throttleT, withCache, withCacheAsync, withDelayArgvQueue, withRepeat, withRepeatAsync, withRetry, withRetryAsync, withTimeoutAsync, withTimeoutPromise
    • String
      • autoEllipsis, createMarkReplacer, escapeHTML, escapeRegExp, filterJoin, forEachLine, forEachRegExpExec, indentLine, indentLineList, indentList, joinCamelCase, joinKebabCase, joinSnakeCase, lazyEncodeURI, removeInvalidCharXML, replaceAll, splitCamelCase, splitKebabCase, splitSnakeCase, unescapeHTML
    • Test
      • createTest
    • Time
      • CLOCK_PER_SECOND, CLOCK_TO_SECOND, cancelFrameUpdate, clock, createStepper, createTimer, getTimestamp, getUTCDateTag, requestFrameUpdate, setAwaitAsync, setTimeoutAsync, setWeakInterval, setWeakTimeout, setWeakTimeoutAsync
    • Verify
      • arrayBuffer, arrayLength, basicArray, basicFunction, basicObject, boolean, doNotThrow, doNotThrowAsync, doThrow, doThrowAsync, includes, integer, notIncludes, notStrictEqual, notStringifyEqual, number, objectAlike, objectContain, objectKey, oneOf, promiseAlike, regexp, strictEqual, string, stringifyEqual, truthy
  • Env
    • assert, getEndianness, tryRequire, tryRequireResolve
  • Node
    • Data
      • Buffer
        • calcHash, createBufferRefragPool, getRandomBufferAsync
      • BufferPacket
        • packBufferPacket, parseBufferPacket
      • Stream
        • bufferToReadableStream, createReadableStreamInputChip, createTransformStreamChip, createWritableStreamOutputChip, isReadableStream, isWritableStream, quickRunletFromStream, readableStreamToBufferAsync, readlineOfStreamAsync, setupStreamPipe, waitStreamStopAsync, writeBufferToStreamAsync
      • Z64String
        • packB64, packBr64, packGz64, unpackB64, unpackBr64, unpackGz64
    • Fs
      • Checksum
        • describeChecksumInfoList, describeChecksumOfPathList, getChecksumInfoListOfPath, getChecksumInfoListOfPathList, getChecksumInfoOfFile
      • Directory
        • copyDirInfoTree, copyDirInfoTreeSync, copyDirectory, copyDirectorySync, createDirectory, createDirectorySync, deleteDirInfoTree, deleteDirInfoTreeSync, deleteDirectory, deleteDirectorySync, getDirInfoList, getDirInfoListSync, getDirInfoTree, getDirInfoTreeSync, getFileList, getFileListSync, getPathTypeFromDirent, renameDirInfoTree, renameDirInfoTreeSync, resetDirectory, resetDirectorySync, walkDirInfoTree, walkDirInfoTreeBottomUp, walkDirInfoTreeBottomUpSync, walkDirInfoTreeSync, withTempDirectory, withTempDirectorySync
      • File
        • appendArrayBuffer, appendArrayBufferSync, appendBuffer, appendBufferSync, appendText, appendTextSync, copyFile, copyFileSync, deleteFile, deleteFileForce, deleteFileForceSync, deleteFileSync, editArrayBuffer, editArrayBufferSync, editBuffer, editBufferSync, editJSON, editJSONPretty, editJSONPrettySync, editJSONSync, editText, editTextSync, readArrayBuffer, readArrayBufferSync, readBuffer, readBufferSync, readJSON, readJSONAlike, readJSONAlikeSync, readJSONSync, readText, readTextSync, renameFile, renameFileSync, writeArrayBuffer, writeArrayBufferSync, writeBuffer, writeBufferSync, writeJSON, writeJSONPretty, writeJSONPrettySync, writeJSONSync, writeText, writeTextSync
      • Modify
        • modifyCopy, modifyCopySync, modifyDelete, modifyDeleteForce, modifyDeleteForceSync, modifyDeleteSync, modifyRename, modifyRenameSync
      • Path
        • PATH_TYPE, STAT_ERROR, addTrailingSep, copyPath, copyPathSync, createPathPrefixLock, deletePath, deletePathForce, deletePathForceSync, deletePathSync, dropTrailingSep, existPath, existPathSync, expandHome, getPathLstat, getPathLstatSync, getPathStat, getPathStatSync, getPathTypeFromStat, nearestExistPath, nearestExistPathSync, renamePath, renamePathSync, resolveHome, toPosixPath
      • Watch
        • createFileWatcherExot
    • Module
      • ActionJSON
        • ACTION_CORE_MAP, ACTION_TYPE, setupActionMap, ACTION_CORE_MAP, ACTION_TYPE, ACTION_CORE_MAP, ACTION_TYPE, setupActionMap
      • Archive
        • check, compressArgs, extractArgs, getArgs, setArgs, verify, REGEXP_AUTO, check, compress7zAsync, compressAutoAsync, compressT7zAsync, extract7zAsync, extractAutoAsync, extractT7zAsync, repackAsync, repackTarAsync, verify, REGEXP_FSP, compressAsync, compressFspAsync, compressFspGzBrAsync, extractAsync, extractFspAsync, extractFspGzBrAsync, REGEXP_BR, REGEXP_GZ, REGEXP_GZBR, REGEXP_T7Z, REGEXP_TBR, REGEXP_TGZ, REGEXP_TXZ, compressGzBrFileAsync, createBrotliCompressMax, createGzipMax, extractGzBrFileAsync, isBufferGzip, isFileGzip, REGEXP_NPM_TAR, check, compressAsync, createCompressStream, createExtractStream, extractAsync, extractPackageJSON, getNpmTar, verify, check, compressArgs, extractArgs, getArgs, setArgs, verify
      • Option
        • createOptionParser, Preset, createOptionGetter, getOptionalFormatFlag, getOptionalFormatValue, parseOptionMap, prepareOption
      • Software
        • catStringToFileCommand, catStringToVarCommand, check, commonBashArgList, commonCommandList, commonSourceProfileCommandList, getArgs, gitCleanUpCommandList, gitFetchBranchCommandList, joinCommand, runBash, runBashCommand, runBashCommandSync, runBashStdout, runBashStdoutSync, runBashSync, setArgs, subShellCommandList, toHeredocNoMagic, verify, check, checkCompose, checkLocalImage, checkPullImage, getArgs, getArgsCompose, getContainerLsList, matchContainerLsList, parseDockerImage, patchContainerLsListStartedAt, pullImage, runCompose, runComposeStdout, runComposeStdoutSync, runComposeSync, runDocker, runDockerStdout, runDockerStdoutSync, runDockerSync, setArgs, setArgsCompose, verify, verifyCompose, check, getArgs, getGitBranch, getGitCommitHash, getGitCommitMessage, runGit, runGitStdout, runGitStdoutSync, runGitSync, setArgs, verify, COMMON_HOST_STATUS_COMMAND_LIST, getCommonHostStatus, fetchLikeRequestWithProxy, fetchWithJumpProxy, findUpNpmrc, findUpPackageRoot, fromGlobalNodeModules, fromNpmNodeModules, getPathNpm, getPathNpmExecutable, getPathNpmGlobalRoot, getSudoArgs, hasRepoVersion, runNpm, runNpmStdout, runNpmStdoutSync, runNpmSync, runSudoNpm, runSudoNpmStdout, runSudoNpmStdoutSync, runSudoNpmSync
      • Auth
        • AUTH_FILE, AUTH_FILE_GROUP, AUTH_SKIP, DEFAULT_AUTH_KEY, configureAuth, configureAuthFile, configureAuthFileGroup, configureAuthSkip, describeAuthFile, generateAuthCheckCode, generateAuthFile, loadAuthFile, saveAuthFile, verifyAuthCheckCode
      • EntityTag
        • getEntityTagByContentHash, getWeakEntityTagByStat
      • FactDatabase
        • INITIAL_FACT_INFO, createFactDatabaseExot, tryDeleteExtraCache, tryLoadFactInfo
      • FileChunkUpload
        • createOnFileChunkUpload, uploadFileByChunk
      • FsPack
        • TYPE_DIRECTORY, TYPE_FILE, TYPE_SYMLINK, append, appendContentList, appendDirectory, appendFile, appendFromPath, appendSymlink, initFsPack, loadFsPack, saveFsPack, setFsPackPackRoot, setFsPackUnpackPath, unpack, unpackContentList, unpackDirectory, unpackFile, unpackSymlink, unpackToPath
      • Log
        • configureLog
      • Logger
        • createLoggerExot, createSimpleLoggerExot
      • PackageJSON
        • editPackageJSON, loadPackageCombo, loadPackageInfo, loadPackageInfoList, savePackageInfo, toPackageJSONPath, toPackageRootPath, writePackageJSON
      • Permission
        • configurePermission
      • Pid
        • configurePid
      • PingRace
        • PING_STAT_ERROR, pingRaceUrlList, pingStatUrlList
      • RuntimeDump
        • dumpSync, getV8Extra, getV8HeapSnapshotReadableStream, setupSIGUSR2, writeV8HeapSnapshot
      • SafeWrite
        • createSafeWriteStream
      • TerminalTTY
        • createColor, createStatusBar, promptAsync
      • Function
        • createArgListPack, probeSync, spawnString
    • Server
      • Feature
        • @
          • HTML
            • LoadingMask
              • initLoadingMask
            • Modal
              • initModal
          • Configure
            • configureFeature, configureServerExot, runServer, runServerExotGroup, setupFeature, setupServer, setupServerExotGroup, startServerExotGroup
          • Option
            • LogFormatConfig, PidFormatConfig, ServerHostFormat, getLogOption, getPidOption, getServerExotFormatConfig, getServerExotOption
        • ActionJSON
          • actionJSON, PERMISSION_CHECK_ACTION_JSON, PERMISSION_CHECK_ACTION_JSON_PUBLIC, setup
        • Auth
          • HTML
            • initAuthMask
          • AuthCommonFormatConfig, AuthFileFormatConfig, AuthFileGroupFormatConfig, AuthSkipFormatConfig, getAuthCommonOption, getAuthFileGroupOption, getAuthFileOption, getAuthSkipOption, setup
        • Explorer
          • HTML
            • getHTML, initPathContent, pathContentStyle, initUploader
          • Option
            • ExplorerFormatConfig, getExplorerOption
          • Setup
            • setup
        • File
          • fileDownload, fileUpload, FileFormatConfig, getFileOption, createResponderFileChunkUpload, createResponderServeFile, PERMISSION_CHECK_FILE_UPLOAD_START, setup
        • Permission
          • PermissionFormatConfig, getPermissionOption, setup
        • ServerFetch
          • HTML
            • initServerFetch
          • responderServerFetch
      • Responder
        • Common
          • createResponderHostMapper, createResponderLog, createResponderLogEnd, createResponderSetHeaderHSTS, responderEnd, responderEndWithRedirect, responderEndWithStatusCode, responderSetHeaderCacheControlImmutable
        • Proxy
          • createResponderHTTPRequestProxy
        • RateLimit
          • createResponderCheckRateLimit, createResponderRateLimit
        • Router
          • METHOD_MAP, appendRouteMap, createResponderRouteListHTML, createResponderRouter, createRouteMap, describeRouteMap, getRouteParam, getRouteParamAny
        • Send
          • createResponderFavicon, prepareBufferData, responderSendBuffer, responderSendBufferCompress, responderSendBufferRange, responderSendJSON, responderSendStream, responderSendStreamCompress, responderSendStreamRange
        • ServeStatic
          • createDefaultCacheMap, createResponderServeStatic
      • WS
        • Base
          • createWSBase
        • Client
          • createWSClient
        • Server
          • createUpgradeRequestListener, enableWSServer
        • createFrameDecodeChip, createCloseFramePack, createFrameEncodeChip, encodeBinaryFramePack, encodePingFramePack, encodePongFramePack, encodeTextFramePack, BUFFER_MAX_LENGTH, FRAME_CONFIG, OPCODE_TYPE, WEBSOCKET_VERSION, applyMaskQuadletBufferInPlace, getRequestKey, getRespondKey, packProtocolList, parseProtocolString
      • Proxy
        • createTCPProxyListener
      • Server
        • createRequestListener, createServerExot, describeServerOption
      • Function
        • DR_BROWSER_FILE_PATH, DR_BROWSER_SCRIPT_TAG, autoTestServerPort, getRequestBuffer, getRequestJSON, getRequestParam, getUnusedPort, getWSProtocolListParam, isPrivateAddress, isRequestAborted, packWSProtocolListParam, parseCookieString, parseHostString
    • System
      • DefaultOpen
        • getDefaultOpenCommandList
      • ExitListener
        • addExitListenerAsync, addExitListenerLossyOnce, addExitListenerSync, clearExitListener, deleteExitListenerAsync, deleteExitListenerSync, guardPromiseEarlyExit
      • Process
        • describeAllProcessStatusAsync, findProcessListInfo, findProcessPidMapInfo, findProcessTreeInfo, flattenProcessTree, getAllProcessStatusAsync, getProcessListAsync, isPidExist, killProcessInfoAsync, killProcessTreeInfoAsync, sortProcessList, toProcessPidMap, toProcessTree
      • ResolveCommand
        • resolveCommand, resolveCommandAsync, resolveCommandName, resolveCommandNameAsync
      • Status
        • V8_HEAP_RESERVED_SIZE, describeSystemActivity, describeSystemMemory, describeSystemNetwork, describeSystemPlatform, describeSystemProcessor, describeSystemStatus, getSystemActivity, getSystemInfo, getSystemMemory, getSystemNetwork, getSystemPlatform, getSystemProcessor, getSystemStatus, getV8HeapStatus
      • WatchLoop
        • LOOP_INDEX, addUnitStateHistory, defaultCommandStop, formatLoopConfig, formatUnitConfig, initLoopState, latestUnitStateHistory, loadLoopState, loopClue, loopMain, loopStop, loopWaitAndStep, markLoopState, migrateLoopState, saveLoopState
    • Kit
      • ENV_KEY_LOGGER, ENV_KEY_VERBOSE, argvFlag, getKit, getKitLogger, getKitPathCombo, getKitRun, loadEnvKey, runKit, saveEnvKey, syncEnvKey
    • Net
      • fetchLikeRequest, fetchWithJump, ping, requestHttp
    • Run
      • describeRunOutcome, describeRunOutcomeSync, run, runDetached, runStdout, runStdoutSync, runSync

Bin Option Format

📄 source-bin/option.js

CLI Usage:
  --config --c -c [OPTIONAL] [ARGUMENT=1]
      from JS/JSON: set to "path/to/config.js|json"
      from ENV: set to "env" to enable, default not check env
      from ENV JSON: set to "json-env:ENV_NAME" to read the ENV string as JSON, or "jz64/jb64-env"
      from CLI JSON: set to "json-cli:JSON_STRING" to read the appended string as JSON, or "jz64/jb64-cli"
  --help --h -h [OPTIONAL] [ARGUMENT=0-1]
      show full help
  --version --v -v [OPTIONAL] [ARGUMENT=0-1]
      show version
  --note --N -N [OPTIONAL] [ARGUMENT=1+]
      noop, tag for ps/htop
  --quiet --q -q [OPTIONAL] [ARGUMENT=0-1]
      less log
  --input-file --I -I [OPTIONAL] [ARGUMENT=1]
      common option
  --output-file --O -O [OPTIONAL] [ARGUMENT=1]
      common option
  --pid-file --pid [OPTIONAL] [ARGUMENT=1]
      common option
  --host --H -H [OPTIONAL] [ARGUMENT=1]
      common option: $0=hostname:port (hostname default to 0.0.0.0)
  --route-prefix --RP [OPTIONAL] [ARGUMENT=1]
      common option: $0=routePrefix (default to "", set like "/prefix")
  --root --R -R [OPTIONAL] [ARGUMENT=1]
      common option: $0=path/cwd
  --timeout --T -T [OPTIONAL] [ARGUMENT=1]
      common option, 0 for unlimited: $0=msec/undefined
  --json --J -J [OPTIONAL] [ARGUMENT=0-1]
      output JSON, if supported
  --eval --e -e [OPTIONAL] [ARGUMENT=0+]
      eval file or string: -O=outputFile, -I/$0=scriptFile/scriptString, $@=...evalArgv
  --repl --i -i [OPTIONAL] [ARGUMENT=0-1]
      start node REPL
  --fetch --f -f [OPTIONAL] [ARGUMENT=1-3]
      fetch url with http_proxy env support: -I=requestBody/null, -O=outputFile/stdout, -T=timeout/0, $@=initialUrl,method/GET,jumpMax/4
  --wait [OPTIONAL] [ARGUMENT=0-1]
      wait specified time, in msec: $0=waitTime/2*1000
  --echo [OPTIONAL] [ARGUMENT=0+]
      show args: $@=...args
  --cat [OPTIONAL] [ARGUMENT=0+]
      with 0 args pipe stdin to stdout, else read $@ as file and pipe to stdout
  --write [OPTIONAL] [ARGUMENT=1]
      for use like ">": `dr-js --cat sourceFile | dr-js --write outputFile`
  --append [OPTIONAL] [ARGUMENT=1]
      for use like ">>": `dr-js --cat sourceFile | dr-js --append outputFile`
  --text-file --txt [OPTIONAL] [ARGUMENT=0-1]
      ">" or ">>" text to file: -O=outputFile, $N=fileTextContent, $1=openMode/write
  --text-replace --tr [OPTIONAL] [ARGUMENT=2]
      replace first string in text file: -I=textFile, $0=fromString, $1=toString
  --text-replace-all --tra [OPTIONAL] [ARGUMENT=2]
      replace all string in text file: -I=textFile, $0=fromString, $1=toString
  --merge [OPTIONAL] [ARGUMENT=2+]
      merge to one file: $@=mergedFile,...inputFileList
  --create-directory --mkdir [OPTIONAL] [ARGUMENT=0+]
      create directory: $@=...pathList
  --modify-copy --cp [OPTIONAL] [ARGUMENT=2]
      copy path: $@=pathFrom,pathTo
  --modify-rename --mv [OPTIONAL] [ARGUMENT=2]
      rename path: $@=pathFrom,pathTo
  --modify-delete --rm [OPTIONAL] [ARGUMENT=0+]
      delete path: $@=...pathList
  --status --s -s [OPTIONAL] [ARGUMENT=0-1]
      basic system status: -J=isOutputJSON
  --open --o -o [OPTIONAL] [ARGUMENT=0-2]
      use system default app to open uri or path: $0=uriOrPath/cwd, $1=isDetached/false
  --which --w -w [OPTIONAL] [ARGUMENT=1]
      resolve to full executable path: -R=resolveRoot/cwd, $0=commandNameOrPath
  --run [OPTIONAL] [ARGUMENT=0+]
      run command: $0=...argsList
  --detach --bg [OPTIONAL] [ARGUMENT=0+]
      run command detached: -O=logFile/ignore, $0=...argsList
  --process-status --ps [OPTIONAL] [ARGUMENT=0-1]
      show system process status: -J=isOutputJSON, $0=outputMode/"pid--"
  --process-signal --sig [OPTIONAL] [ARGUMENT=0-2]
      send signal to process by pid: -I=pidFile $@=pid/pidFile,signal/"SIGTERM"
  --json-format --jf [OPTIONAL] [ARGUMENT=0-1]
      re-format JSON file: -O=outputFile/-I, -I=inputFile, $0=unfoldLevel/2
  --encode --enc [OPTIONAL] [ARGUMENT=1]
      encode text as "b64/gz64/br64": -O=outputFile/stdout, $N=text, $1=codecType
  --decode --dec [OPTIONAL] [ARGUMENT=1]
      decode text as "b64/gz64/br64": -O=outputFile/stdout, $N=text, $1=codecType
  --file-list --ls [OPTIONAL] [ARGUMENT=0-1]
      list file: $0=path/cwd
  --file-list-all --ls-R --lla [OPTIONAL] [ARGUMENT=0-1]
      list all file: $0=path/cwd
  --file-tree --tree [OPTIONAL] [ARGUMENT=0-1]
      list all file in tree: $0=path/cwd
  --compress --a -a [OPTIONAL] [ARGUMENT=0-1]
      compress to archive: -I=inputDirectory, -O=outputFile
  --extract --x -x [OPTIONAL] [ARGUMENT=0-1]
      extract from archive: -I=inputFile, -O=outputPath
  --docker --dk [OPTIONAL] [ARGUMENT=1+]
      run "docker" command: $@=...argList
  --docker-compose --dc [OPTIONAL] [ARGUMENT=1+]
      run "docker-compose" command: $@=...argList
  --auth-file-describe [OPTIONAL] [ARGUMENT=0-1]
      describe auth file: -I=authFile
  --auth-check-code-generate [OPTIONAL] [ARGUMENT=0-1]
      generate checkCode from auth file: -I=authFile, $0=timestamp/now
  --auth-check-code-verify [OPTIONAL] [ARGUMENT=1-2]
      verify checkCode with auth file: -I=authFile, $@=checkCode,timestamp/now
  --auth-gen-tag [OPTIONAL] [ARGUMENT=1]
      generate auth file: -O=outputFile
    --auth-gen-size [ARGUMENT=1]
    --auth-gen-token-size [ARGUMENT=1]
    --auth-gen-time-gap [ARGUMENT=1]
    --auth-gen-info [ARGUMENT=1]
  --ping-race [OPTIONAL] [ARGUMENT=1+]
      tcp-ping list of url to find the fastest: -T=timeout/5000, $@=...urlList
  --ping-stat [OPTIONAL] [ARGUMENT=1+]
      tcp-ping list of url and print result: -T=timeout/5000, $@=...urlList
  --server-serve-static --sss [OPTIONAL] [ARGUMENT=0-1]
      static file server: -H=hostname:port, -R=staticRoot/cwd, $0=expireTime/5*1000
  --server-serve-static-simple --ssss [OPTIONAL] [ARGUMENT=0-1]
      static file server, no HTML: -H=hostname:port, -R=staticRoot/cwd, $0=expireTime/5*1000
  --server-serve-static-api --sssa [OPTIONAL] [ARGUMENT=0-1]
      static API server, no HTML, will map "POST /a/b/c" to static file with name "#a#b#c#[POST]": -H=hostname:port, -R=staticRoot/cwd, $0=expireTime/5*1000
  --server-websocket-group --swg [OPTIONAL]
      websocket chat server: -H=hostname:port
  --server-test-connection --stc [OPTIONAL]
      connection test server: -H=hostname:port
  --server-test-connection-simple --stcs [OPTIONAL]
      connection test server, just log all & json back: -H=hostname:port
  --server-test-connection-simple-payload --stcsp [OPTIONAL]
      connection test server, just log all & json back with payload-base64: -H=hostname:port
  --server-tcp-proxy --stp [OPTIONAL] [ARGUMENT=1+]
      tcp proxy server: -H=hostname:port, $@=toHostname:toPort,toHostname:toPort,...
  --server-http-request-proxy --shrp [OPTIONAL] [ARGUMENT=1+]
      HTTP per-request proxy server: -H=hostname:port, -T=timeout/42000, $0=toOrigin, $1=isSetXForward/false
ENV Usage:
  "
    #!/usr/bin/env bash
    export DR_JS_CONFIG="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_HELP="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_VERSION="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_NOTE="[OPTIONAL] [ARGUMENT=1+]"
    export DR_JS_QUIET="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_INPUT_FILE="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_OUTPUT_FILE="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_PID_FILE="[OPTIONAL] [ARGUMENT=1] [ALIAS=DR_JS_PID]"
    export DR_JS_HOST="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_ROUTE_PREFIX="[OPTIONAL] [ARGUMENT=1] [ALIAS=DR_JS_RP]"
    export DR_JS_ROOT="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_TIMEOUT="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_JSON="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_EVAL="[OPTIONAL] [ARGUMENT=0+]"
    export DR_JS_REPL="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_FETCH="[OPTIONAL] [ARGUMENT=1-3]"
    export DR_JS_WAIT="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_ECHO="[OPTIONAL] [ARGUMENT=0+]"
    export DR_JS_CAT="[OPTIONAL] [ARGUMENT=0+]"
    export DR_JS_WRITE="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_APPEND="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_TEXT_FILE="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_TXT]"
    export DR_JS_TEXT_REPLACE="[OPTIONAL] [ARGUMENT=2] [ALIAS=DR_JS_TR]"
    export DR_JS_TEXT_REPLACE_ALL="[OPTIONAL] [ARGUMENT=2] [ALIAS=DR_JS_TRA]"
    export DR_JS_MERGE="[OPTIONAL] [ARGUMENT=2+]"
    export DR_JS_CREATE_DIRECTORY="[OPTIONAL] [ARGUMENT=0+] [ALIAS=DR_JS_MKDIR]"
    export DR_JS_MODIFY_COPY="[OPTIONAL] [ARGUMENT=2] [ALIAS=DR_JS_CP]"
    export DR_JS_MODIFY_RENAME="[OPTIONAL] [ARGUMENT=2] [ALIAS=DR_JS_MV]"
    export DR_JS_MODIFY_DELETE="[OPTIONAL] [ARGUMENT=0+] [ALIAS=DR_JS_RM]"
    export DR_JS_STATUS="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_OPEN="[OPTIONAL] [ARGUMENT=0-2]"
    export DR_JS_WHICH="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_RUN="[OPTIONAL] [ARGUMENT=0+]"
    export DR_JS_DETACH="[OPTIONAL] [ARGUMENT=0+] [ALIAS=DR_JS_BG]"
    export DR_JS_PROCESS_STATUS="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_PS]"
    export DR_JS_PROCESS_SIGNAL="[OPTIONAL] [ARGUMENT=0-2] [ALIAS=DR_JS_SIG]"
    export DR_JS_JSON_FORMAT="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_JF]"
    export DR_JS_ENCODE="[OPTIONAL] [ARGUMENT=1] [ALIAS=DR_JS_ENC]"
    export DR_JS_DECODE="[OPTIONAL] [ARGUMENT=1] [ALIAS=DR_JS_DEC]"
    export DR_JS_FILE_LIST="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_LS]"
    export DR_JS_FILE_LIST_ALL="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_LS_R,DR_JS_LLA]"
    export DR_JS_FILE_TREE="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_TREE]"
    export DR_JS_COMPRESS="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_EXTRACT="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_DOCKER="[OPTIONAL] [ARGUMENT=1+] [ALIAS=DR_JS_DK]"
    export DR_JS_DOCKER_COMPOSE="[OPTIONAL] [ARGUMENT=1+] [ALIAS=DR_JS_DC]"
    export DR_JS_AUTH_FILE_DESCRIBE="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_AUTH_CHECK_CODE_GENERATE="[OPTIONAL] [ARGUMENT=0-1]"
    export DR_JS_AUTH_CHECK_CODE_VERIFY="[OPTIONAL] [ARGUMENT=1-2]"
    export DR_JS_AUTH_GEN_TAG="[OPTIONAL] [ARGUMENT=1]"
    export DR_JS_AUTH_GEN_SIZE="[ARGUMENT=1]"
    export DR_JS_AUTH_GEN_TOKEN_SIZE="[ARGUMENT=1]"
    export DR_JS_AUTH_GEN_TIME_GAP="[ARGUMENT=1]"
    export DR_JS_AUTH_GEN_INFO="[ARGUMENT=1]"
    export DR_JS_PING_RACE="[OPTIONAL] [ARGUMENT=1+]"
    export DR_JS_PING_STAT="[OPTIONAL] [ARGUMENT=1+]"
    export DR_JS_SERVER_SERVE_STATIC="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_SSS]"
    export DR_JS_SERVER_SERVE_STATIC_SIMPLE="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_SSSS]"
    export DR_JS_SERVER_SERVE_STATIC_API="[OPTIONAL] [ARGUMENT=0-1] [ALIAS=DR_JS_SSSA]"
    export DR_JS_SERVER_WEBSOCKET_GROUP="[OPTIONAL] [ALIAS=DR_JS_SWG]"
    export DR_JS_SERVER_TEST_CONNECTION="[OPTIONAL] [ALIAS=DR_JS_STC]"
    export DR_JS_SERVER_TEST_CONNECTION_SIMPLE="[OPTIONAL] [ALIAS=DR_JS_STCS]"
    export DR_JS_SERVER_TEST_CONNECTION_SIMPLE_PAYLOAD="[OPTIONAL] [ALIAS=DR_JS_STCSP]"
    export DR_JS_SERVER_TCP_PROXY="[OPTIONAL] [ARGUMENT=1+] [ALIAS=DR_JS_STP]"
    export DR_JS_SERVER_HTTP_REQUEST_PROXY="[OPTIONAL] [ARGUMENT=1+] [ALIAS=DR_JS_SHRP]"
  "
CONFIG Usage:
  {
    "config": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "help": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "version": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "note": [ "[OPTIONAL] [ARGUMENT=1+]" ],
    "quiet": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "inputFile": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "outputFile": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "pidFile": [ "[OPTIONAL] [ARGUMENT=1] [ALIAS=pid]" ],
    "host": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "routePrefix": [ "[OPTIONAL] [ARGUMENT=1] [ALIAS=RP]" ],
    "root": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "timeout": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "json": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "eval": [ "[OPTIONAL] [ARGUMENT=0+]" ],
    "repl": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "fetch": [ "[OPTIONAL] [ARGUMENT=1-3]" ],
    "wait": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "echo": [ "[OPTIONAL] [ARGUMENT=0+]" ],
    "cat": [ "[OPTIONAL] [ARGUMENT=0+]" ],
    "write": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "append": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "textFile": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=txt]" ],
    "textReplace": [ "[OPTIONAL] [ARGUMENT=2] [ALIAS=tr]" ],
    "textReplaceAll": [ "[OPTIONAL] [ARGUMENT=2] [ALIAS=tra]" ],
    "merge": [ "[OPTIONAL] [ARGUMENT=2+]" ],
    "createDirectory": [ "[OPTIONAL] [ARGUMENT=0+] [ALIAS=mkdir]" ],
    "modifyCopy": [ "[OPTIONAL] [ARGUMENT=2] [ALIAS=cp]" ],
    "modifyRename": [ "[OPTIONAL] [ARGUMENT=2] [ALIAS=mv]" ],
    "modifyDelete": [ "[OPTIONAL] [ARGUMENT=0+] [ALIAS=rm]" ],
    "status": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "open": [ "[OPTIONAL] [ARGUMENT=0-2]" ],
    "which": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "run": [ "[OPTIONAL] [ARGUMENT=0+]" ],
    "detach": [ "[OPTIONAL] [ARGUMENT=0+] [ALIAS=bg]" ],
    "processStatus": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=ps]" ],
    "processSignal": [ "[OPTIONAL] [ARGUMENT=0-2] [ALIAS=sig]" ],
    "jsonFormat": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=jf]" ],
    "encode": [ "[OPTIONAL] [ARGUMENT=1] [ALIAS=enc]" ],
    "decode": [ "[OPTIONAL] [ARGUMENT=1] [ALIAS=dec]" ],
    "fileList": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=ls]" ],
    "fileListAll": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=lsR,lla]" ],
    "fileTree": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=tree]" ],
    "compress": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "extract": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "docker": [ "[OPTIONAL] [ARGUMENT=1+] [ALIAS=dk]" ],
    "dockerCompose": [ "[OPTIONAL] [ARGUMENT=1+] [ALIAS=dc]" ],
    "authFileDescribe": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "authCheckCodeGenerate": [ "[OPTIONAL] [ARGUMENT=0-1]" ],
    "authCheckCodeVerify": [ "[OPTIONAL] [ARGUMENT=1-2]" ],
    "authGenTag": [ "[OPTIONAL] [ARGUMENT=1]" ],
    "authGenSize": [ "[ARGUMENT=1]" ],
    "authGenTokenSize": [ "[ARGUMENT=1]" ],
    "authGenTimeGap": [ "[ARGUMENT=1]" ],
    "authGenInfo": [ "[ARGUMENT=1]" ],
    "pingRace": [ "[OPTIONAL] [ARGUMENT=1+]" ],
    "pingStat": [ "[OPTIONAL] [ARGUMENT=1+]" ],
    "serverServeStatic": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=sss]" ],
    "serverServeStaticSimple": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=ssss]" ],
    "serverServeStaticApi": [ "[OPTIONAL] [ARGUMENT=0-1] [ALIAS=sssa]" ],
    "serverWebsocketGroup": [ "[OPTIONAL] [ALIAS=swg]" ],
    "serverTestConnection": [ "[OPTIONAL] [ALIAS=stc]" ],
    "serverTestConnectionSimple": [ "[OPTIONAL] [ALIAS=stcs]" ],
    "serverTestConnectionSimplePayload": [ "[OPTIONAL] [ALIAS=stcsp]" ],
    "serverTcpProxy": [ "[OPTIONAL] [ARGUMENT=1+] [ALIAS=stp]" ],
    "serverHttpRequestProxy": [ "[OPTIONAL] [ARGUMENT=1+] [ALIAS=shrp]" ],
  }