Welcome to Rampart’s documentation.

Contents:

• Rampart JavaScript
  • Preface
    • Acknowledgement
    • License
    • What does it do?
  • Features
    • Core features of Duktape
    • Rampart additions
  • Rampart philosophy
  • Rampart Global Variable and Functions
    • rampart.globalize
    • rampart.localize
    • rampart.utils
    • rampart.event
      • rampart.event.on()
      • rampart.event.trigger()
      • rampart.event.off()
      • rampart.event.remove()
      • rampart.event.scopeToModule()
      • Example
    • rampart.include
    • rampart.import
      • csvFile
      • csv
  • Process Global Variable and Functions
    • exit
    • env
    • argv
    • installPath
    • installPathBin
    • modulesPath
    • scriptPath
    • scriptName
    • script
    • getpid
    • getppid
    • setProcTitle
    • nCpu
    • getTotalMem
    • getFreeMem
    • uptime
    • systemUptime
    • getCpuInfo
    • setMaxMem
  • Using the require Function to Import Modules
    • Example creating a JavaScript module
    • Example creating a C module
    • Module Search Path
  • Extra JavaScript Functionality
    • Object Methods
    • Array Methods
    • String Methods
    • Template Literals
    • Tagged Functions
    • Rest Parameters
    • Template Literals and sprintf
    • Unescaped Literals
    • Duktape/Node.js Buffer Binding Extras
      • Supported encodings
      • Static methods
      • Prototype methods
      • Examples
    • TypedArray Methods
    • TextEncoder / TextDecoder
    • Map and Set
    • console Extras
    • Proxy.revocable
    • WHATWG / W3C Web Platform APIs (experimental)
    • Intl
    • Other Globals
    • setTimeout()
    • clearTimeout()
    • setInterval()
    • clearInterval()
    • setMetronome()
    • clearMetronome()
  • Additional Global Variables and Functions
  • ECMAScript 2015+ and Babel.js
    • Babel Acknowledgement
    • Babel License
    • Activating Babel
    • How it works
    • Caveats
  • ECMAScript 2015+ with transpiler
    • Tree-sitter Acknowledgement
    • Tree-sitter License
    • Activating the Transpiler
    • Transpiler Options
    • Why use the transpiler instead of Babel?
  • Skipping a second pass: the "noTranspile" directive
• Rampart Utility Functions
  • License
  • General Utilities
    • printf
    • sprintf
    • bprintf
    • abprintf
    • hexify
    • dehexify
    • stringToNumber
    • stringToBuffer
    • bufferToString
    • objectToQuery
    • queryToObject
    • getchar
    • readFile
    • writeFile
    • appendFile
    • trim
    • minify
    • stat
    • lstat
    • exists
    • statVfs
    • exec
    • getenv
    • setenv
    • unsetenv
    • shell
    • fork
    • newPipe
    • daemon
    • forkpty
    • kill
    • getcwd
    • chdir
    • mkdir
    • mkdTemp
    • rmdir
    • readDir
    • walkDir
    • glob
    • zipList
    • zipGet
    • zipExtract
    • copyFile
    • cp
    • rmFile
    • rm
    • link
    • symlink
    • readLink
    • chmod
    • realPath
    • truncate
    • touch
    • rename
    • chown
    • lchown
    • lchmod
    • lUtimes
    • sleep
    • tmpDir
    • homeDir
    • getType
    • timezone
    • dateFmt
    • scanDate
    • autoScanDate
    • use
    • load
    • errorConfig
    • deepCopy
    • eventCallback
    • getScopeVars
    • repl
  • File Handle Utilities
    • fopen
    • fopenBuffer
    • fclose
    • fprintf
    • fseek
    • rewind
    • ftell
    • fflush
    • fread
    • fgets
    • fwrite
    • readLine
  • Handle stat/sync/truncate/chmod/chown/utimes
    • fh.fstat
    • fh.fsync
    • fh.fdatasync
    • fh.ftruncate
    • fh.fchmod
    • fh.fchown
    • fh.fUtimes
    • fh.fileNo
  • POSIX File Descriptor I/O
    • Open flag constants (rampart.utils.O)
    • open
    • close
    • read
    • write
    • lseek
    • fstatFd
    • fsyncFd
    • fdatasyncFd
    • ftruncateFd
    • fchmodFd
    • fchownFd
    • futimesFd
    • Example: durable atomic write
  • File Watching
    • watch
      • Limitations
  • Compression and Checksums
    • gzip
    • gunzip
    • deflate
    • inflate
    • deflateRaw
    • inflateRaw
    • crc32
    • adler32
  • Rand, Hash and HyperLogLog
    • rand
    • irand
    • gaussrand
    • normrand
    • srand
    • hash
    • hll
    • hll.add
    • hll.addFile
    • hll.count
    • hll.merge
    • hll.getBuffer
• Rampart Thread Functions
  • Preface
    • License
    • What does it do?
    • How does it work?
  • Thread Functions
    • new rampart.thread()
    • thr.exec()
    • thr.close()
    • thr.terminate()
    • thr.getId()
    • rampart.thread.getCurrentId()
    • rampart.thread.put()
    • rampart.thread.get()
    • rampart.thread.onGet()
    • rampart.thread.del()
    • rampart.thread.waitfor()
  • Lock Functions
    • new rampart.lock()
    • thrlock.lock()
    • thrlock.unlock()
    • thrlock.trylock()
    • Lock Caveats
• Rampart Vector Functions
  • Preface
    • License
    • Acknowledgement
    • What does it do?
  • Vectors in General
    • Why use Vectors?
    • Vector Distance Primer
      • Dot Product / Inner Product
      • Cosine Distance
      • Euclidean Distance (L2)
      • L2-Normalization
      • Common Use In Semantic Search
    • Typed Vectors in Rampart
    • Vector Representations in Rampart
  • Typed Vectors
    • new rampart.vector()
    • Return Value from new rampart.vector()
    • Vector Object Conversion Functions
    • Information Constants
    • Utility Functions
    • Distance Function
  • Raw Vector Conversion Functions
    • rampart.vector.raw.numbersToF64
    • rampart.vector.raw.numbersToF32
    • rampart.vector.raw.numbersToF16
    • rampart.vector.raw.numbersToBf16
    • rampart.vector.raw.numbersToI8
    • rampart.vector.raw.numbersToU8
    • rampart.vector.raw.f64ToNumbers
    • rampart.vector.raw.f32ToNumbers
    • rampart.vector.raw.f16ToNumbers
    • rampart.vector.raw.bf16ToNumbers
    • rampart.vector.raw.u8ToNumbers
    • rampart.vector.raw.i8ToNumbers
    • rampart.vector.raw.f64ToF32
    • rampart.vector.raw.f64ToF16
    • rampart.vector.raw.f64ToBf16
    • rampart.vector.raw.f64ToI8
    • rampart.vector.raw.f64ToU8
    • rampart.vector.raw.f32ToF64
    • rampart.vector.raw.f16ToF64
    • rampart.vector.raw.bf16ToF64
    • rampart.vector.raw.i8ToF64
    • rampart.vector.raw.u8ToF64
    • rampart.vector.raw.f32ToF16
    • rampart.vector.raw.f32ToBf16
    • rampart.vector.raw.f32ToI8
    • rampart.vector.raw.f32ToU8
    • rampart.vector.raw.f16ToF32
    • rampart.vector.raw.bf16ToF32
    • rampart.vector.raw.u8ToF32
    • rampart.vector.raw.i8ToF32
    • rampart.vector.raw.f16ToI8
    • rampart.vector.raw.f16ToU8
    • rampart.vector.raw.i8ToF16
    • rampart.vector.raw.u8ToF16
    • rampart.vector.raw.l2NormalizeNumbers
    • rampart.vector.raw.l2NormalizeF64
    • rampart.vector.raw.l2NormalizeF32
    • rampart.vector.raw.l2NormalizeF16
  • Raw Vector Distance Function
• The rampart-sql module
  • Preface
    • Acknowledgment
    • License
    • Vector Index Acknowledgment
    • What does it do?
    • Documentation Caveat
    • Further Reading
  • Loading the Javascript Module
  • Database Functions
    • init() constructor
    • connection() constructor
    • connect()
    • exec()
      • Sql.list() - IN-list parameters
    • query()
    • one()
    • set()
    • reset()
    • importCsvFile()
    • importCsv()
    • close()
    • addTable()
  • Column Data Types
    • A note on the var prefix
    • Character and text
    • Binary and blob
    • Integer
    • Floating point
    • Date and time
    • Identifier and special
    • Vector
  • Database Indexing
    • Regular Indexes
    • Fulltext Indexes
    • Compound Indexes
    • Vector Indexes
    • Removing Indexes
    • Further Reading
  • Vector Search
    • Overview
    • Storage
    • Generating embeddings
    • Querying
    • Indexing
    • Migrating between dtypes
  • String Functions
    • stringFormat()
    • abstract()
    • sandr()
    • sandr2()
    • rex()
    • re2()
    • rexFile()
    • re2File()
    • searchFile()
    • searchText()
  • Server Functions
    • Vector Function
      • vecdist
      • embed
    • General Functions
      • exec
      • mminfo
      • convert
      • seq
      • random
      • bintohex
      • hextobin
      • identifylanguage
      • lookup
      • lookupCanonicalizeRanges
      • lookupParseRange
      • ifNull
      • isNull
    • File functions
      • fromfile, fromfiletext
      • toind
      • canonpath
      • pathcmp
      • basename
      • dirname
      • fileext
      • joinpath
      • joinpathabsolute
    • String Functions
      • abstract
      • text2mm
      • keywords
      • length
      • lower
      • upper
      • initcap
      • sandr
      • separator
      • stringcompare
      • stringformat
    • Math functions
    • Date functions
    • Bit manipulation functions
    • Internet/IPV4 address functions
      • urlcanonicalize
    • Geographical coordinate functions
      • azimuth2compass
      • azimuthgeocode
      • azimuthlatlon
      • dms2dec, dec2dms
      • distgeocode
      • distlatlon
      • latlon2geocode, latlon2geocodearea
      • geocode2lat, geocode2lon
      • parselatitude, parselongitude
    • JSON functions
      • JSON Path Syntax
      • JSON Field Syntax
      • isjson
      • json_format
      • json_type
      • json_value
      • json_query
      • json_modify
      • json_merge_patch
      • json_merge_preserve
      • Full Example Using Json
  • Server Properties
    • Search and optimization parameters
      • defaultLike
      • matchMode
      • pRedoPtType
      • textSearchMode
      • stringCompareMode
      • stringCompareMode/textSearchMode parameters
      • btreeCacheSize
      • ramRows
      • ramLimit
      • bubble
      • optimize,noOptimize
      • options,noOptions
      • ignoreNewList
      • indexWithin
      • wildOneWord
      • wildSufMatch
      • wildSingle
      • alLinearDict
      • indexMinSublen
      • dropWordMode
      • metamorphStrlstMode
    • Metamorph parameters
      • minWordLen
      • keepNoise
      • suffixProc
      • prefixProc
      • rebuild
      • useEquiv
      • useDerivations
      • intersects
      • hyphenPhrase
      • wordc
      • langc
      • withinMode
      • phrasewordproc
      • defSuffRm
      • eqPrefix
      • exactPhrase
      • noiseList
      • listNoise
      • suffixList
      • listSuffix
      • suffixEquivsList
      • listSuffixEquivs
      • prefixList
      • listPrefix
      • uEqPrefix
    • Rank knobs
      • likepProximity
      • likepLeadBias
      • likepOrder
      • likepDocFreq
      • likepTblFreq
    • Other Ranking Properties
      • likepRows
      • likepMode
      • likepAllMatch
      • likepObeyIntersects
      • likepInfThresh
      • likepIndexThresh
    • Vector Index Properties
      • likevRows
      • likevEf
      • likevPqNprobe
    • Embedding Properties
      • llamaEmbed
      • llamaEmbedPerThread
    • Indexing properties
      • indexSpace
      • indexBlock
      • indexMem
      • indexMeter
      • meter
      • addExp
      • delExp
      • lstExp
      • addIndexTmp
      • delIndexTmp
      • lstIndexTmp
      • indexValues
      • btreeThreshold
      • maxLinearRows
      • likerRows
      • indexAccess
      • indexMmap
      • indexReadBufSz
      • indexWriteBufSz
      • indexMmapBufSz
      • indexSlurp
      • indexAppend
      • indexWriteSplit
      • indexBtreeExclusive
      • mergeFlush
      • indexVersion
      • indexMaxSingle
      • tableReadBufSz
    • Miscellaneous Properties
      • tableSpace
      • dateFmt
      • timeZone
      • locale
      • indirectSpace
      • triggerMode
      • paramChk
      • varcharToStrlstMode
      • strlstToVarcharMode
      • multiValueToMultiRow
      • inMode
      • hexifyBytes
      • unalignedBufferWarning
      • unneededRexEscapeWarning
      • nullOutputString
      • validateBtrees
    • Query Protection
      • alEquivs
      • alIntersects
      • alLinear
      • alNot
      • alPostProc
      • alWild
      • alWithin
      • denyMode
      • qMaxSets
      • qMaxSetWords
      • qMaxWords
      • qMinPrelen
      • qMinWordLen
      • querySettings
    • Restoring Defaults
      • sql.reset()
  • The rampart-sql Command Line Utilities
    • The tsql Command Line Utility
    • The kdbfchk Command Line Utility
    • The addtable Command Line Utility
    • The rex Command Line Utility
    • The metamorph Command Line Utility
• The rampart-server module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How can I quickly start a webserver?
    • How does it work?
  • Loading and Using the Module
    • Loading
    • Configuring and Starting the Server
      • start()
  • Server Usage Details
    • Path Mapping
      • Mapped Functions
      • Mapped Directories
    • The Request Object
      • Posting Form Data
      • Posting Multipart Form Data
      • Posting JSON Data
      • Posting Other Types
    • The Return Object
      • The Return Object with Defer
    • Built-in Directory Function
    • Advanced Functions
      • req.printf()
      • req.put()
      • req.getpos()
      • req.rewind()
      • req.getBuffer()
    • Full Server Example
    • Chunking Replies
      • The Basics
      • req.chunkSend()
      • req.chunkEnd()
      • req.chunkIndex
      • Chunking Examples
    • Websockets
      • req.wsSend(data)
      • req.wsEnd([immediate])
      • req.wsOnDisconnect(func)
      • req.wsIsBin
      • req.count
      • req.websocketId
      • Example echo/chat server
    • Reverse Proxy (Experimental)
      • Basic Configuration
      • Proxy Options
      • Forwarded Headers
      • Error Handling
      • WebSocket Proxying
      • When to Use the Built-in Proxy
  • Standard Server Layout
  • C-API
    • Basic Layout
    • Typedefs
      • rpserv
      • rp_server_map
      • multipart_postvar
    • Macros
      • INIT_RPSERV
      • RP_EXPORT_FUNCTION
      • RP_EXPORT_MAP
    • Get Functions
      • rp_server_get_param
      • rp_server_get_header
      • rp_server_get_query
      • rp_server_get_post
      • rp_server_get_path
      • rp_server_get_cookie
      • rp_server_get_body
      • rp_server_get_req_json
    • Get Multiple Values Functions
      • rp_server_get_queries
      • rp_server_get_posts
      • rp_server_get_params
      • rp_server_get_headers
      • rp_server_get_paths
      • rp_server_get_cookies
    • Get Multipart Form Data
      • rp_server_get_multipart_length
      • rp_server_get_multipart_postitem
    • Put Functions
      • rp_server_put
      • rp_server_put_string
      • rp_server_put_and_free
      • rp_server_put_string_and_free
      • rp_server_printf
    • Header Function
      • rp_server_add_header
    • End Functions
      • rp_server_put_reply
      • rp_server_put_reply_string
      • rp_server_put_reply_and_free
      • rp_server_put_reply_string_and_free
  • Technical Notes
  • Key to Mime Mappings
• The rampart-auth module
  • Preface
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Enabling Authentication
    • Configuration File
      • Configuration Properties
    • Protected Paths
  • The Auth Function Contract
    • For file requests
    • For app module requests
    • The req.userAuth Object
    • CSRF Protection
  • Custom Auth Modules
  • The auth.js Administration Module
    • CLI Administration
    • HTTP Endpoints
    • Programmatic API
    • User Records vs Session Records
      • Custom Properties in Endpoint Callbacks
    • Session Data Model
    • Theme Support
    • OAuth Plugins
      • Included Plugins
      • Using OAuth on Login Pages
      • OAuth User Records
      • Writing a Custom Plugin
    • Hooks for Custom Authentication Flows
  • Security Considerations
  • Quick Start
• The rampart-net module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
  • Loading and Using the Module
    • Loading
  • Socket Functions
    • new net.Socket()
    • socket.connect()
    • socket.write()
    • socket.startTls()
    • socket.on()
    • socket.off()
    • socket.once()
    • socket.destroy()
    • socket.setTimeout()
    • socket.setKeepAlive()
    • socket.trigger()
    • socket.bytesWritten
    • socket.bytesRead
    • Other socket properties
    • Socket Full Example
  • Server Functions
    • new net.Server()
    • server.listen()
    • server.on()
    • server.off()
    • server.once()
    • server.connectionCount()
    • server.maxConnections()
    • Other server properties
    • Server Full Example
  • WebSocket Client Functions
    • net.wsConnect()
    • wsclient.wsSend()
    • wsclient.wsClose()
    • WebSocket Client Events
    • WebSocket Client Example
  • Resolve functions
    • new net.Resolver()
    • resolver.resolve()
    • resolver.reverse()
    • resolver.on()
    • net.resolve()
      • Typed DNS Queries
    • net.reverse()
  • Shortcut Functions
    • net.createConnection()
    • net.createServer()
    • net.resolve_async()
    • net.reverse_async()
• The rampart-html module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Configuring and Parsing
    • newDocument
    • objToHtml
  • Manipulating the HTML
    • The html object
    • destroy
    • Selecting Elements
      • findTag
      • findAttr
      • findClass
    • Output from Elements
      • getElement
      • getElementName
      • getAttr
      • getAllAttr
      • toObj
    • Text and HTML Output
      • toHtml
      • toText
      • prettyPrint
    • Traversing HTML tree
      • next
      • prev
      • children
      • parent
      • getDocument
    • Manipulating the List of Elements
      • filterTag
      • filterAttr
      • filterClass
      • slice
      • eq
      • add
    • Testing Elements
      • hasTag
      • hasAttr
      • hasClass
    • Manipulating Elements
      • attr
      • removeAttr
      • addClass
      • removeClass
      • detach
      • delete
      • append
      • prepend
      • after
      • before
      • replace
• The rampart-chromeview module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Prerequisites
    • Loading
    • Quick Start
  • Calling Conventions
    • Synchronous
    • Callback
    • Promise / async-await
    • Page-side callbacks: strings always work; functions require “use transpiler”
    • Event-driven features need the main event loop
  • Known Limitations
    • Sync mode and event-triggered waits do not mix
    • Function.prototype.toString returns a stub in plain Duktape
    • Worker — Runtime only, no DOM
    • page.queryObjects requires a real JSHandle prototype
    • ConsoleMessage shape
    • Cleanup of launched Chrome on script exit
    • HTML5 drag-and-drop requires explicit interception
  • Module-Level Functions
    • chrome.launch()
    • chrome.connect()
    • chrome.executablePath()
    • chrome.defaultArgs()
    • chrome.devices
    • chrome.networkConditions
    • chrome.TimeoutError
  • Browser
    • Browser events
  • BrowserContext
  • Page
    • Navigation
    • Content and Evaluation
    • Selectors
    • Interaction
    • Waiting
    • Screenshots and PDF
    • Cookies
    • Emulation
    • Misc page accessors
    • Page events
    • Binding functions
    • Request interception
  • Frame
  • JSHandle
  • ElementHandle
  • Mouse
  • Keyboard
  • Request
  • Response
  • Target
  • CDPSession
  • Worker
  • Coverage
  • Tracing
  • FileChooser
  • Accessibility
  • ConsoleMessage
  • Dialog
  • Example: scrape a rendered SPA and save a PDF
  • Using puppeteer-extras
    • What it provides
    • Loading
    • Use with rampart-chromeview
    • Why “use transpiler” is required
    • Bundled packages
    • Why a bundle
• The rampart-crypto module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Encryption and Decryption
    • encrypt
    • decrypt
    • passToKeyIv
    • Supported Modes
  • RSA Encryption
    • rsa_gen_key
    • rsa_import_priv_key
    • rsa_components
    • rsa_pub_encrypt
    • rsa_priv_decrypt
    • rsa_sign
    • rsa_verify
  • EC Encryption
    • ec_gen_key
    • ec_import_pub_key
    • ec_import_priv_key
    • ec_components
    • ecdsa_sign
    • ecdsa_verify
    • ecdh
  • X25519 and Ed25519
    • x25519_gen_key
    • x25519_import_pub_key
    • x25519_import_priv_key
    • x25519_components
    • x25519_derive
    • ed25519_gen_key
    • ed25519_import_pub_key
    • ed25519_import_priv_key
    • ed25519_components
    • ed25519_sign
    • ed25519_verify
  • X448 and Ed448
  • Post-Quantum (ML-KEM, ML-DSA)
    • ML-KEM (Key Encapsulation Mechanism)
      • mlkem_gen_key
      • mlkem_encapsulate
      • mlkem_decapsulate
      • mlkem_import_pub_key / mlkem_import_priv_key / mlkem_components
    • ML-DSA (Module-Lattice Digital Signature Algorithm)
      • mldsa_gen_key
      • mldsa_sign
      • mldsa_verify
      • mldsa_import_pub_key / mldsa_import_priv_key / mldsa_components
    • gen_csr
    • gen_cert
    • cert_info
  • Password
    • passwd
    • passwdComponents
    • passwdCheck
  • Hashing
    • hash
    • alias functions
    • hmac
    • kmac
    • cshake128 / cshake256
  • Key Derivation
    • pbkdf2
    • hkdf
    • scrypt
  • Random
    • rand
    • randnum
    • gaussrand
    • normrand
    • seed
  • Comparison
    • timingSafeEqual
  • PEM / DER conversion
    • pemToDer
    • derToPem
  • BigInt
    • JSBI.BigInt
    • JSBI Compatible functions
    • toSignedString
• The rampart-curl module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Main Functions
    • fetch()
      • fetch() Results
      • Adding More Requests
    • submit()
    • fetchAsync()
      • finally()
    • submitAsync()
    • Promise / async-await Support
    • cancel
    • setCaCert()
    • encode()
    • decode()
    • cleanup()
    • default_ca_file
  • Curl Options
    • Curl long options
      • Supported Options
      • Unsupported Extras
    • Additional options
    • Curl short options
  • Examples
    • Simple HTTP Get request
    • Multiple HTTP Get Requests
    • Multiple HTTP request with addurl()
    • Posting Multipart-Form Data
    • Multiple HTTP Post with Submit()
    • Sending Email with SMTP
    • Sending Email with Attachments
• The rampart-lmdb module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Terminology
  • Main Function (init)
  • LMDB Easy Functions
    • openDb
    • get
    • put
    • del
    • drop
    • sync
    • getCount
    • listDbs
    • close
    • Easy Functions Full Example
  • LMDB Transaction Functions
    • lmdb.transaction
    • txn.get
    • txn.getRef
    • txn.put
    • txn.del
    • Using Cursors
    • txn.cursorGet
    • txn.cursorPut
    • txn.cursorDel
    • txn.cursorNext
    • txn.cursorPrev
    • txn.commit
    • txn.abort
    • Transaction Functions Full Example
• The rampart-redis module
  • Preface
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Main Function
    • init()
  • Client Functions
    • Client Commands
  • Shortcut Commands
    • _async Commands
    • Promise / async-await Support
    • format
    • xread_block_async
    • xread_auto_async
  • Supported Commands
    • Return Values from Supported Commands
  • Unsupported Commands
  • Proxy Objects
    • Creation
    • Usage
    • Caveats
• The rampart-totext module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Supported Formats
  • External Dependencies
    • pdftotext
    • catdoc
  • Loading and Using the Module
    • Loading
  • Functions
    • convertFile
    • convert
    • identify
  • Output Format
  • Notes on Specific Formats
    • DOCX
    • PPTX
    • XLSX
    • ODT / ODP / ODS
    • EPUB
    • Markdown
    • PDF
    • Legacy Word (.doc)
• The rampart-python module
  • Preface
    • License
    • What does it do?
    • How does it work?
  • Loading the Javascript Module
  • Python Module Functions
    • python.import()
    • python.importString()
    • python.importFile()
    • pvar.toString()
    • pvar.toValue()
  • Handling Variables
    • From Javascript to Python
    • From Python to JavaScript
    • Python to Python
    • Python Named Arguments
  • Calling rampart from within Python
    • rampart.call
    • rampart.triggerEvent
  • Example Use Importing Data
• The rampart-robots module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Main Function
    • isAllowed()
  • Example
• The rampart-cmark module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Main Function
    • toHtml
  • Examples
    • Basic CommonMark
    • GitHub Flavored Markdown Extensions
  • Client-Side Rendering
    • Math Rendering — MathJax
    • Syntax Highlighting — highlight.js
    • GitHub-Style Alerts
    • Tables and General GitHub Styling — github-markdown-css
    • Full Minimal Page
• The rampart-treesitter module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • Properties
    • languages
  • Functions
    • extractSymbols
    • parse
  • Examples
    • Extracting Symbols
    • Inspecting the AST
    • Handling Parse Errors
    • Parsing a Configuration File
• The rampart-langtools modules
  • Preface
    • Acknowledgment
    • License
    • What do they do?
    • Platform Availability
  • The rampart-llamacpp module
    • modelInfo
    • initEmbed
      • emb.embedTextToFp16Buf()
      • emb.embedTextToFp32Buf()
      • emb.embedTextToNumbers()
      • emb.destroy()
    • initRerank
      • rr.rerank()
    • initGen
      • gen.predict()
      • gen.predictAsync()
      • gen.getLast()
      • gen.destroy()
    • Common Model and Context Options
    • getLog
    • resetLog
    • Environment Variables
  • The rampart-faiss module
    • openFactory
    • openIndexFromFile
    • idx.settings
    • idx.addFp32()
    • idx.addFp16()
    • idx.searchFp32()
    • idx.searchFp16()
    • idx.save()
    • idx.enableGpu()
    • idx.trainer()
    • trainer.addTrainingfp32()
    • trainer.addTrainingfp16()
    • trainer.train()
  • The rampart-sentencepiece module
    • init
    • encoder.encode()
    • decode
  • Putting It Together
• The rampart-almanac module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
  • Loading and Using the Module
    • Loading
  • Celestial Positions
    • almanac.suntimes()
    • almanac.moontimes()
    • almanac.celestials()
    • almanac.seasons()
  • Holidays
    • new almanac.Holiday()
  • Weather
    • almanac.weather.configure()
    • almanac.weather.search()
    • almanac.weather.current()
    • almanac.weather.forecast()
    • almanac.weather.history()
    • almanac.weather.airQuality()
    • almanac.weather.marine()
    • almanac.weather.weatherAt()
    • almanac.weather.clearCache()
    • almanac.weather.weatherCodes
    • Async Callbacks
• The rampart-url module
  • Preface
    • License
    • What does it do?
    • How does it work?
  • Loading and Using the Module
    • Loading
  • URL Functions
    • components
    • absUrl
• The rampart-gm module
  • Preface
    • Acknowledgment
    • License
    • What does it do?
    • How does it work?
    • Prerequisites
  • Loading and Using the Module
    • Loading
  • gm Object Functions
    • open()
  • Image Object Methods
    • add()
    • mogrify()
    • save()
    • toBuffer()
    • select()
    • list()
    • getCount()
    • identify()
    • close()
  • Example: Creating an Animated GIF
  • Example: Thumbnail Server
• Extras
  • Preface
    • What is in this section?
  • rampart-webserver.js Module
    • Loading the module.
    • Standard Server Layout
    • Usage from a configuration file
    • Building a command line utility
    • Use with Letsencrypt
  • Single-File Bundles
    • What a Bundle Is (And Is Not)
    • Building a Bundle
    • How a Bundle Starts
    • The :zip:/ Filesystem
      • Bundle-Specific JS APIs
    • Use With the Web Server
    • Pre-Compiled Caches
    • Native Modules and Daemons
    • What Is Not Supported
    • Running a Specific Script From the Bundle
  • websocket_client
  • forkpty-term
  • rampart-converter
  • rampart-email
    • Loading the module
    • send()
    • Delivery Methods
    • HTML email with attachment
  • rampart-llm
    • Loading the module
    • Creating a connection
    • Instance properties
    • query()
    • Chat example
    • Multi-turn conversation
    • Cancelling a query
    • Overriding params per query
    • Tool use
    • Loading providers from a JSON config file
    • Capacity and token usage
    • Cycle detection and debug logging
    • Thinking/reasoning models
    • Context overflow behavior
    • Using with the Rampart web server
  • The c_module_template_maker utility
    • Creating a C Module template
    • Example usage to create a module
  • rampart-cmodule
  • Rampart Macros for C Modules
  • Intl and WHATWG
  • rampart-nodeshim Module
    • Loading
    • Submodules and notable gaps
    • Tested libraries
    • Not implemented
• Tutorials
  • Find Cities and their Closest Neighbors
    • Preface
      • License
    • Concepts
    • Getting Started
      • Web Server Layout
    • Importing the Data
      • Examine your CSV
      • Creating the table
      • Importing the CSV
      • Building Indexes
      • The Final Import Script
    • Web Server Script
      • Web Server Script Mapping
      • Delivering Static Content
      • The Nearest City Results
      • The Auto-Complete Results
      • The Complete Server-Side Script
    • The Complete Script
  • Using Websockets to Build a Chat
    • Preface
      • License
    • Concepts
    • Getting Started
      • Web Server Layout
      • The Client HTML and Script
    • Websockets Server Script
      • The Basics of Rampart-Server Websockets
      • Setup on Connect
      • Receiving from Client and Forward
      • Receiving from other Clients
      • Full Script
    • Handling Binary Data
      • Client-side Additions
      • Receiving Files from Client and Forward
      • Receiving Files from other Clients
      • Full Script Handling Files
    • Chat with History using Redis
      • Client-Side changes
      • Starting Redis
      • Replacing Event Functions
      • Listening for Messages
      • Forwarding Messages
      • Full Script with Redis
    • Improvements
  • Building a Pi News Aggregator
    • Preface
      • License
    • Concepts
    • Getting Started
      • Web Server Layout
    • The Aggregator
      • Examining the External Sites
      • Defining the Table
      • Parsing The Index Page HTML
      • Inserting New URLs into the Table
      • The First Run - Grabbing the Index Pages
      • Update Runs - Grabbing New Article URLs
      • Updating Content
      • Processing the Articles
      • The Final Aggregator Script
    • Client-Side Script
    • Improvements
• FAQ
  • General
    • How do I install Rampart?
    • What is Rampart and how does it differ from Node.js?
    • Can I use npm packages with Rampart?
    • What version of ECMAScript does Rampart support?
    • What are Rampart’s non-standard JavaScript extensions?
    • Are operations synchronous or asynchronous by default?
    • What is rampart.globalize and why do I see it in so many scripts?
  • Modules
    • How does require() work compared to Node.js?
    • What is the difference between require() and rampart.include()?
    • How do I write a C module for Rampart?
  • Concurrency and Asynchronous Programming
    • How does Rampart’s threading model work?
    • Why can’t my thread see variables I defined after creating it?
    • How do threads communicate with each other?
    • Does Rampart support Promises and async/await?
    • What are the transpiler gotchas I should know about?
    • Why did my setTimeout callback fire late?
  • HTTP Server
    • How does rampart-server compare to Express.js?
    • How do I structure a Rampart web application?
    • What is web_server_conf.js and when should I use it?
    • How do I serve static files?
    • How do I handle POST data and file uploads?
    • How do I access request parameters?
    • How do WebSockets work?
    • How do I return different content types?
    • How do I handle async operations in a mapped function?
    • How do I generate HTML in mapped functions?
    • How do I make HTTP requests from Rampart?
    • Why don’t my variables persist between requests?
  • Database and Search
    • What is Texis and how does it compare to SQLite?
    • How does full-text index maintenance work?
    • How do I build a full-text search over documents (PDF, DOCX, etc.)?
    • When should I use rampart-sql vs rampart-lmdb vs rampart-redis?
    • What is sql.one() and when should I use it?
    • What is the difference between sql.exec() and sql.query()?
    • How do I prevent SQL injection?
  • File I/O and System
    • How does file I/O work compared to Node’s fs module?
    • What are the extended printf format codes?
    • How do I run external commands?
    • How do fork() and daemon() work?
  • Buffers and Data
    • What buffer types are available and how do they differ?
    • How do I handle objects with cyclic references?
  • Deployment
    • How do I daemonize and deploy the Rampart server?
    • How do I set up HTTPS?
  • Interoperability
    • Can I call Python code from Rampart?
  • Vibe Coding with Rampart
    • How do I use an LLM coding assistant to build Rampart applications?