Files & Transfer

Filesystem access, archives and moving bytes. Each function lists its parameters, defaults and return value.

File Namespace

File system operations.

Scope: System

Functions

Function	Description
file.read()	Read file contents
file.write()	Write content to a file
file.exists()	Check if a file or directory exists
file.remove()	Remove a file or directory
file.copy()	Copy a file
file.move()	Move or rename a file
file.mkdir()	Create a directory

file.read()

Read the contents of a file.

Parameters

Parameter	Type	Default	Description
path	string	—	File path to read (required)
encoding	string	"utf-8"	Text encoding

Returns

Field	Type	Description
success	bool	Whether read succeeded
content	string	File contents

Examples

// Read a file
let result = file.read({ path: "/config/settings.json" })
log(result.content)

// Read with home directory expansion
let result = file.read({ path: "~/.ssh/config" })
log(result.content)

// Check success
let result = file.read({ path: "/etc/hostname" })
if (result.success) {
  log("Hostname: " + result.content.trim())
}

file.write()

Write content to a file.

Parameters

Parameter	Type	Default	Description
path	string	—	File path to write (required)
content	string	—	Content to write (required)
append	bool	false	Append instead of overwrite
create	bool	true	Create file if it doesn’t exist
mode	string	"0644"	File permissions (octal)

Returns

Field	Type	Description
success	bool	Whether write succeeded

Examples

// Write a file
file.write({
  path: "/tmp/output.txt",
  content: "Hello, World!"
})

// Append to a file
file.write({
  path: "/var/log/app.log",
  content: "New log entry\n",
  append: true
})

// Write JSON data
let data = { name: "app", version: "1.0" }
file.write({
  path: "/tmp/config.json",
  content: JSON.stringify(data, null, 2)
})

file.exists()

Check if a file or directory exists.

Parameters

Parameter	Type	Default	Description
path	string	—	Path to check (required)

Returns

Field	Type	Description
success	bool	Whether the check succeeded
exists	bool	Whether the path exists
isDir	bool	Whether the path is a directory

Examples

// Check if a file exists
let result = file.exists({ path: "/config/settings.json" })
if (result.exists) {
  log("Config file found")
}

// Check if a directory exists
let result = file.exists({ path: "/app/node_modules" })
if (result.exists && result.isDir) {
  log("Dependencies installed")
}

file.remove()

Remove a file or directory.

Parameters

Parameter	Type	Default	Description
path	string	—	Path to remove (required)
recursive	bool	false	Remove directories recursively

Returns

Field	Type	Description
success	bool	Whether removal succeeded

Examples

// Remove a file
file.remove({ path: "/tmp/output.txt" })

// Remove a directory recursively
file.remove({ path: "/tmp/build", recursive: true })

file.copy()

Copy a file from source to destination.

Parameters

Parameter	Type	Default	Description
source	string	—	Source file path (required)
destination	string	—	Destination file path (required)
overwrite	bool	false	Overwrite existing file

Returns

Field	Type	Description
success	bool	Whether copy succeeded

Examples

// Copy a file
file.copy({
  source: "/config/template.yaml",
  destination: "/config/settings.yaml"
})

// Copy with overwrite
file.copy({
  source: "/tmp/new-config.json",
  destination: "/app/config.json",
  overwrite: true
})

file.move()

Move or rename a file.

Parameters

Parameter	Type	Default	Description
source	string	—	Source file path (required)
destination	string	—	Destination file path (required)
overwrite	bool	false	Overwrite existing file

Returns

Field	Type	Description
success	bool	Whether move succeeded

Examples

// Rename a file
file.move({
  source: "/tmp/output.txt",
  destination: "/tmp/result.txt"
})

// Move with overwrite
file.move({
  source: "/tmp/new-config.json",
  destination: "/app/config.json",
  overwrite: true
})

file.mkdir()

Create a directory.

Parameters

Parameter	Type	Default	Description
path	string	—	Directory path to create (required)
recursive	bool	true	Create parent directories as needed
mode	string	"0755"	Directory permissions (octal)

Returns

Field	Type	Description
success	bool	Whether directory creation succeeded

Examples

// Create a directory
file.mkdir({ path: "/tmp/output" })

// Create nested directories
file.mkdir({ path: "/app/data/cache/images" })

// Non-recursive (parent must exist)
file.mkdir({ path: "/app/new-dir", recursive: false })

Glob Namespace

File pattern matching functions.

Scope: System

Functions

Function	Description
glob.find()	Find files matching a glob pattern

glob.find()

Find files matching a glob pattern.

Parameters

Parameter	Type	Default	Description
pattern	string	—	Glob pattern to match (required, e.g., "**/*.txt", "*.go")
path	string	"."	Base directory to search in
exclude	array	—	Patterns to exclude
filesOnly	bool	false	Return only files, not directories
dirsOnly	bool	false	Return only directories, not files

Returns

Field	Type	Description
success	bool	Whether the search succeeded
matches	array	Array of matching file paths

Examples

// Find all YAML files
let result = glob.find({ pattern: "**/*.yaml" })
log("Found " + result.matches.length + " YAML files")

// Find files in a specific directory
let result = glob.find({
  pattern: "*.go",
  path: "/app/src"
})

// Exclude patterns
let result = glob.find({
  pattern: "**/*.js",
  path: "/app",
  exclude: ["node_modules/**", "dist/**"]
})

// Files only (no directories)
let result = glob.find({
  pattern: "**/*",
  path: "/app/config",
  filesOnly: true
})

// Directories only
let result = glob.find({
  pattern: "*",
  path: "/app",
  dirsOnly: true
})

Archive Namespace

Archive extraction and compression functions.

Scope: System

Functions

Function	Description
archive.extract()	Extract an archive file
archive.compress()	Create an archive from files or directories

archive.extract()

Extract an archive file (tar, tar.gz, tar.bz2, zip).

Parameters

Parameter	Type	Default	Description
source	string	—	Path to archive file (required)
destination	string	—	Extraction destination directory (required)
format	string	(auto)	Archive format — auto-detected from extension if not specified
stripRoot	bool	false	Remove root directory from extracted paths

Returns

Field	Type	Description
success	bool	Whether extraction succeeded
path	string	Extraction destination path

Examples

// Extract a tar.gz archive
archive.extract({
  source: "/tmp/app-v1.2.tar.gz",
  destination: "/opt/app"
})

// Extract with root stripping
archive.extract({
  source: "/tmp/release.zip",
  destination: "/opt/app",
  stripRoot: true
})

// Extract with explicit format
archive.extract({
  source: "/tmp/data.archive",
  destination: "/data",
  format: "tar.gz"
})

archive.compress()

Create an archive from files or directories.

Parameters

Parameter	Type	Default	Description
source	string	—	Single source path (file or directory)
sources	array	—	Array of source paths (alternative to source)
destination	string	—	Output archive path (required)
format	string	(auto)	Archive format — auto-detected from extension if not specified

Returns

Field	Type	Description
success	bool	Whether compression succeeded
path	string	Output archive path

Examples

// Compress a directory
archive.compress({
  source: "/app/dist",
  destination: "/tmp/app-dist.tar.gz"
})

// Compress multiple sources
archive.compress({
  sources: ["/app/dist", "/app/config"],
  destination: "/tmp/release.zip"
})

// Explicit format
archive.compress({
  source: "/data/output",
  destination: "/tmp/data.archive",
  format: "tar.gz"
})

Extract Namespace

Content extraction from structured documents.

Scope: System

Functions

Function	Description
extract.markdown()	Extract content from Markdown documents

extract.markdown()

Extract structured content from Markdown documents — code blocks by language, sections by heading, or specific matches by index.

Parameters

Parameter	Type	Default	Description
content	string	—	Inline Markdown content to extract from
file	string	—	File path to read content from
glob	string	—	Glob pattern for multiple files
select	string	—	CSS/path selector to narrow extraction
language	string	—	Filter code blocks by language
heading	string	—	Filter sections by heading text
index	int	—	Select a specific match by index

At least one of content, file, or glob is required.

Returns

Field	Type	Description
success	bool	Whether extraction succeeded
content	string	Extracted content
blocks	array	Extracted code blocks (when filtering by language)

Examples

// Extract code blocks by language
let result = extract.markdown({
  content: readmeContent,
  language: "yaml"
})
log("Found " + result.blocks.length + " YAML blocks")

// Extract section by heading
let section = extract.markdown({
  file: "./docs/README.md",
  heading: "Getting Started"
})
log(section.content)

// Extract from file with language filter
let config = extract.markdown({
  file: "./docs/guide.md",
  language: "json",
  index: 0
})
log("First JSON block: " + config.content)

// Extract from multiple files
let results = extract.markdown({
  glob: "./docs/**/*.md",
  heading: "Installation"
})
log(results.content)

Rsync Namespace

Rsync file synchronization functions. Shells out to the local rsync binary (must be on PATH, or set via rsyncPath) and threads SSH transport parameters through -e ssh ....

Scope: Network

Functions

Function	Description
rsync.push()	Sync a local path to a remote host (local → remote)
rsync.pull()	Sync a remote path to a local path (remote → local)
rsync.sync()	Push or pull based on a direction parameter

Common Parameters

All three functions accept the same parameter map.

Connection

Parameter	Type	Default	Description
host	string	—	Remote host (required)
user	string	—	SSH username
port	int	22	SSH port
keyPath	string	—	Path to private key file
jumpHost	string	—	Jump/bastion host
jumpUser	string	—	Jump host username
jumpPort	int	22	Jump host SSH port
jumpKeyPath	string	—	Jump host private key path
sshCommand	string	—	Custom ssh command — overrides keyPath/port/jumpHost when set
rsyncPath	string	"rsync"	Path to the rsync binary

Paths and direction

Parameter	Type	Default	Description
localPath	string	—	Local file or directory (required)
remotePath	string	—	Remote file or directory (required)
direction	string	"push"	"push" or "pull" — used by rsync.sync() only

Rsync flags

Parameter	Type	Default	Description
archive	bool	false	Archive mode (-a) — recursive + symlinks + perms + times + owner + group + devices
compress	bool	false	Compress during transfer (-z)
verbose	bool	false	Verbose output (-v)
progress	bool	false	Show transfer progress (--progress)
delete	bool	false	Delete extraneous files at the destination (--delete)
dryRun	bool	false	Trial run, no changes (-n)
recursive	bool	false	Recursive (-r). Implied by archive
preservePerms	bool	false	Preserve permissions (-p). Implied by archive
preserveTimes	bool	false	Preserve modification times (-t). Implied by archive
preserveOwner	bool	false	Preserve owner (-o). Implied by archive
preserveGroup	bool	false	Preserve group (-g). Implied by archive
checksum	bool	false	Compare with checksums instead of mtime+size (-c)
partial	bool	false	Keep partially-transferred files (--partial)
partialDir	string	—	Directory for partial files (--partial-dir)
bandwidthLimit	int	0	Bandwidth cap in KB/s (--bwlimit)
timeout	int	0	I/O timeout in seconds (--timeout)

Filter patterns

Parameter	Type	Description
exclude	string[]	Patterns passed via --exclude
include	string[]	Patterns passed via --include
excludeFrom	string	File of exclude patterns (--exclude-from)
includeFrom	string	File of include patterns (--include-from)

Escape hatch

Parameter	Type	Description
extraArgs	string[]	Additional arguments appended to the rsync command line

Returns

Field	Type	Description
success	bool	Whether the sync succeeded
bytesSent	int	Bytes sent to the remote
bytesReceived	int	Bytes received from the remote
filesTransferred	int	Number of files transferred
totalFiles	int	Total files considered
output	string	Captured stdout
errorOutput	string	Captured stderr
exitCode	int	rsync exit code
error	string	Error message when success is false

Examples

Push a build to a webserver

let result = rsync.push({
  host: "web.example.com",
  user: "deploy",
  keyPath: "~/.ssh/id_rsa",
  localPath: "./dist/",
  remotePath: "/var/www/html/",
  archive: true,
  compress: true,
  delete: true
})
log("Sent " + result.bytesSent + " bytes")

Pull a remote backup

rsync.pull({
  host: "db.example.com",
  user: "backup",
  keyPath: "~/.ssh/backup_key",
  remotePath: "/var/backups/db/",
  localPath: "./backups/",
  archive: true,
  progress: true
})

Dry-run with filters

let preview = rsync.push({
  host: "prod.example.com",
  user: "deploy",
  keyPath: "~/.ssh/prod_key",
  localPath: "./src/",
  remotePath: "/srv/app/",
  archive: true,
  delete: true,
  dryRun: true,
  exclude: ["*.log", "node_modules/", ".git/"],
  include: ["*.config.js"]
})
log(preview.output)

Through a jump host

rsync.push({
  host: "10.0.5.20",
  user: "deploy",
  keyPath: "~/.ssh/internal_key",
  jumpHost: "bastion.example.com",
  jumpUser: "jumper",
  jumpKeyPath: "~/.ssh/bastion_key",
  localPath: "./release/",
  remotePath: "/opt/release/",
  archive: true
})

Custom SSH transport

rsync.push({
  host: "host.example.com",
  sshCommand: "ssh -o StrictHostKeyChecking=yes -o UserKnownHostsFile=~/.ssh/prod_known_hosts -i ~/.ssh/prod_key",
  localPath: "./dist/",
  remotePath: "/srv/app/",
  archive: true
})

Direction-based dispatch

function syncTree(dir) {
  return rsync.sync({
    host: "host.example.com",
    user: "deploy",
    keyPath: "~/.ssh/id_rsa",
    localPath: "./tree/",
    remotePath: "/var/tree/",
    archive: true,
    direction: dir                  // "push" or "pull"
  })
}

Bandwidth-limited transfer

rsync.push({
  host: "remote.example.com",
  user: "ops",
  keyPath: "~/.ssh/id_rsa",
  localPath: "./large-dataset/",
  remotePath: "/data/",
  archive: true,
  bandwidthLimit: 1024,             // 1 MB/s cap
  partial: true,
  partialDir: ".rsync-partial"
})

SCP Namespace

SCP file transfer functions. Built on the standalone registry/scp package which adds jump-host (ProxyJump) chains, strict host key checking, and explicit authMethod selection on top of the basic SCP transport.

For a connection-less single-call SCP that piggybacks on the SSH namespace’s client, see ssh.upload / ssh.download. Use the scp namespace when you need jump hosts, agent auth selection, or known_hosts verification.

Scope: Network

Functions

Function	Description
scp.upload()	Upload a local file or directory to a remote host
scp.download()	Download a remote file or directory to the local host
scp.transfer()	Upload or download based on a direction parameter

Common Parameters

All three functions accept the same parameter map.

Connection

Parameter	Type	Default	Description
host	string	—	Remote host or host:port (required)
user	string	—	SSH username (required)
password	string	—	Password for password auth
keyPath	string	—	Path to private key file
keyPassphrase	string	—	Passphrase for an encrypted private key
authMethod	string	inferred	"key", "password", or "agent". Inferred from credentials when omitted
timeout	int	120	Connection timeout in seconds
strictHostKeyChecking	bool	false	Verify the host key against known_hosts
knownHostsPath	string	—	Path to a known_hosts file
jumpHosts	array	—	Ordered list of jump/bastion hosts; see below

Transfer

Parameter	Type	Default	Description
localPath	string	—	Local file or directory (required)
remotePath	string	—	Remote file or directory (required)
recursive	bool	false	Copy directories recursively
preserveMode	bool	false	Preserve file permissions and timestamps
direction	string	"upload"	"upload" or "download" — used by scp.transfer() only

Jump Hosts

jumpHosts is an array of map entries. Each entry accepts:

Field	Type	Description
host	string	Jump host host or host:port
user	string	SSH username on the jump host
password	string	Password for password auth
keyPath	string	Path to private key file
keyPassphrase	string	Passphrase for the private key
authMethod	string	"key", "password", or "agent"

Hosts are dialed in order. The final SSH connection to host is tunnelled through every jump host in sequence.

When strictHostKeyChecking: true, every hop — including every jump host — is verified against the same known_hosts file. When strictHostKeyChecking is left off, both the target and the jump hosts skip verification.

Returns

Field	Type	Description
success	bool	Whether the transfer succeeded
bytesTransferred	int	Total bytes transferred
filesTransferred	int	Number of files transferred (multi-file when recursive: true)
error	string	Error message when success is false

Examples

Simple upload

let result = scp.upload({
  host: "server.example.com",
  user: "deploy",
  keyPath: "~/.ssh/id_rsa",
  localPath: "./dist/app.tar.gz",
  remotePath: "/tmp/app.tar.gz"
})
log("Uploaded " + result.bytesTransferred + " bytes")

Recursive download with permissions

scp.download({
  host: "server.example.com",
  user: "deploy",
  keyPath: "~/.ssh/id_rsa",
  remotePath: "/etc/myapp/",
  localPath: "./backup/config/",
  recursive: true,
  preserveMode: true
})

Through a jump host

scp.upload({
  host: "10.0.5.20",                  // private-network target
  user: "deploy",
  keyPath: "~/.ssh/internal_key",
  jumpHosts: [
    {
      host: "bastion.example.com:22",
      user: "jumper",
      keyPath: "~/.ssh/bastion_key"
    }
  ],
  localPath: "./release.tar.gz",
  remotePath: "/opt/releases/release.tar.gz"
})

Verified host key

scp.upload({
  host: "prod.example.com",
  user: "deploy",
  keyPath: "~/.ssh/prod_key",
  strictHostKeyChecking: true,
  knownHostsPath: "~/.ssh/known_hosts",
  localPath: "./build/server",
  remotePath: "/usr/local/bin/server",
  preserveMode: true
})

Direction-based dispatch

function syncArtifact(dir) {
  return scp.transfer({
    host: "server.example.com",
    user: "deploy",
    keyPath: "~/.ssh/id_rsa",
    localPath: "./artifact.bin",
    remotePath: "/var/cache/artifact.bin",
    direction: dir                       // "upload" or "download"
  })
}

S3 Namespace

S3-compatible storage functions.

Scope: Network

Functions

Function	Description
s3.upload()	Upload files to S3
s3.download()	Download files from S3
s3.list()	List objects in S3
s3.delete()	Delete objects from S3

Common Connection Parameters

All functions require these connection parameters:

Parameter	Type	Default	Description
endpoint	string	—	S3 endpoint URL (required)
accessKey	string	—	Access key ID (required)
secretKey	string	—	Secret access key (required)
bucket	string	—	Bucket name (required)
secure	bool	false	Use HTTPS
insecureSkipVerify	bool	false	Skip TLS certificate verification

s3.upload()

Upload files or directories to S3.

Parameters

Parameter	Type	Default	Description
source	string	—	Local file/directory path (required)
destination	string	—	S3 object key/prefix (required)
recursive	bool	true	Upload directories recursively

Returns

Field	Type	Description
success	bool	Whether upload succeeded
uploaded	int	Number of files uploaded

Examples

// Upload a file
s3.upload({
  endpoint: "s3.amazonaws.com",
  accessKey: "AKIAIOSFODNN7EXAMPLE",
  secretKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  bucket: "my-bucket",
  secure: true,
  source: "/tmp/backup.tar.gz",
  destination: "backups/backup.tar.gz"
})

// Upload a directory (MinIO)
s3.upload({
  endpoint: "minio.local:9000",
  accessKey: "minioadmin",
  secretKey: "minioadmin",
  bucket: "artifacts",
  source: "/app/dist/",
  destination: "releases/v1.0/",
  recursive: true
})

s3.download()

Download files from S3.

Parameters

Parameter	Type	Default	Description
object	string	—	S3 object key to download (required)
path	string	—	Local destination path (required)

Returns

Field	Type	Description
success	bool	Whether download succeeded
downloaded	int	Number of files downloaded

Examples

// Download a file
s3.download({
  endpoint: "s3.amazonaws.com",
  accessKey: "AKIAIOSFODNN7EXAMPLE",
  secretKey: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
  bucket: "my-bucket",
  secure: true,
  object: "backups/backup.tar.gz",
  path: "/tmp/backup.tar.gz"
})

s3.list()

List objects in an S3 bucket.

Parameters

Parameter	Type	Default	Description
prefix	string	—	Filter objects by prefix

Returns

Field	Type	Description
success	bool	Whether listing succeeded
objects	array	Array of objects with name, size, modTime, isDir

Examples

// List all objects
let result = s3.list({
  endpoint: "minio.local:9000",
  accessKey: "minioadmin",
  secretKey: "minioadmin",
  bucket: "artifacts"
})
for (let obj of result.objects) {
  log(obj.name + " (" + obj.size + " bytes)")
}

// List with prefix filter
let result = s3.list({
  endpoint: "minio.local:9000",
  accessKey: "minioadmin",
  secretKey: "minioadmin",
  bucket: "artifacts",
  prefix: "releases/v1.0/"
})

s3.delete()

Delete objects from S3.

Parameters

Parameter	Type	Default	Description
path	string	—	Object key or prefix to delete (required)
recursive	bool	false	Delete all objects with the given prefix

Returns

Field	Type	Description
success	bool	Whether deletion succeeded
deleted	int	Number of objects deleted

Examples

// Delete a single object
s3.delete({
  endpoint: "minio.local:9000",
  accessKey: "minioadmin",
  secretKey: "minioadmin",
  bucket: "artifacts",
  path: "old-release.tar.gz"
})

// Delete all objects with prefix
s3.delete({
  endpoint: "minio.local:9000",
  accessKey: "minioadmin",
  secretKey: "minioadmin",
  bucket: "artifacts",
  path: "releases/v0.9/",
  recursive: true
})

Azure Blob Namespace

Azure Blob storage functions.

Scope: Network

Functions

Function	Description
azureblob.upload()	Upload files to Azure Blob Storage
azureblob.download()	Download files from Azure Blob Storage
azureblob.list()	List blobs in a container
azureblob.delete()	Delete blobs from Azure Blob Storage

azureblob.upload()

Upload files or directories to Azure Blob Storage with parallel processing and incremental sync support.

Parameters

Parameter	Type	Default	Description
connectionString	string	—	Azure storage connection string (required)
maxRetries	int	3	Maximum retry attempts
maxWorkers	int	4	Concurrent upload workers
incremental	bool	false	Only upload changed files
continueOnError	bool	true	Continue on individual file errors
syncMode	string	—	Sync mode: "fast" or "hash"
container	string	—	Blob container name (required)
source	string	—	Local file/directory path (required)
destination	string	—	Blob prefix/path (required)
recursive	bool	true	Upload directories recursively
skipPatterns	array	—	Patterns to skip

Returns

Field	Type	Description
success	bool	Whether upload succeeded
uploaded	int	Number of files uploaded
skipped	int	Number of files skipped

Examples

// Upload a directory
azureblob.upload({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "assets",
  source: "/app/dist/",
  destination: "releases/v1.0/"
})

// Incremental upload (only changed files)
azureblob.upload({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "static",
  source: "/app/public/",
  destination: "web/",
  incremental: true,
  syncMode: "hash",
  skipPatterns: ["*.tmp", ".DS_Store"]
})

azureblob.download()

Download files from Azure Blob Storage.

Parameters

Parameter	Type	Default	Description
connectionString	string	—	Azure storage connection string (required)
maxRetries	int	3	Maximum retry attempts
maxWorkers	int	4	Concurrent download workers
incremental	bool	false	Only download changed files
continueOnError	bool	true	Continue on individual file errors
container	string	—	Blob container name (required)
prefix	string	—	Blob prefix to download
destination	string	—	Local destination path (required)
skipPatterns	array	—	Patterns to skip

Returns

Field	Type	Description
success	bool	Whether download succeeded
downloaded	int	Number of files downloaded
skipped	int	Number of files skipped

Examples

// Download all blobs with prefix
azureblob.download({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "backups",
  prefix: "db/daily/",
  destination: "/tmp/restore/"
})

// Incremental download
azureblob.download({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "assets",
  prefix: "images/",
  destination: "/app/public/images/",
  incremental: true
})

azureblob.list()

List blobs in an Azure Blob Storage container.

Parameters

Parameter	Type	Default	Description
connectionString	string	—	Azure storage connection string (required)
container	string	—	Blob container name (required)
prefix	string	—	Blob prefix to filter

Returns

Field	Type	Description
success	bool	Whether listing succeeded
blobs	array	Array of blobs with name, size, lastModified, contentType

Examples

// List all blobs in container
let result = azureblob.list({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "assets"
})
for (let blob of result.blobs) {
  log(blob.name + " (" + blob.size + " bytes, " + blob.contentType + ")")
}

// List with prefix filter
let result = azureblob.list({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "assets",
  prefix: "images/"
})

azureblob.delete()

Delete blobs from Azure Blob Storage.

Parameters

Parameter	Type	Default	Description
connectionString	string	—	Azure storage connection string (required)
container	string	—	Blob container name (required)
prefix	string	—	Blob prefix to delete
blobName	string	—	Specific blob name to delete

Returns

Field	Type	Description
success	bool	Whether deletion succeeded
deleted	int	Number of blobs deleted

Examples

// Delete a specific blob
azureblob.delete({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "assets",
  blobName: "old-file.txt"
})

// Delete all blobs with prefix
azureblob.delete({
  connectionString: "DefaultEndpointsProtocol=https;AccountName=...",
  container: "temp",
  prefix: "uploads/2023/"
})