S3LoaderOptions
Auto-generated API reference for S3LoaderOptions.
Interface: S3LoaderOptions
Defined in: loaders.ts:171
Document loaders: small async functions that return
InputDocument[] ready to pipe into RAG.ingest. Every loader
is framework-agnostic and accepts a custom fetch for tests.
#Extends
#Properties
#bucket
bucket:
string
Defined in: loaders.ts:177
#client
client:
S3LikeClient
Defined in: loaders.ts:176
AWS SDK v3 S3Client-shaped client. Bring your own to keep the bundle
lean. Works with R2 / MinIO / etc. by configuring the client's endpoint.
#commands?
optionalcommands?:object
Defined in: loaders.ts:183
AWS SDK v3 commands. Pass them in to skip the dynamic import:
\{ ListObjectsV2Command, GetObjectCommand \} from @aws-sdk/client-s3.
Optional — when omitted the loader resolves them lazily.
#GetObjectCommand
GetObjectCommand: (
input) =>object
Parameters
input
Record<string, unknown>
Returns
object
input
input:
Record<string,unknown>
#ListObjectsV2Command
ListObjectsV2Command: (
input) =>object
Parameters
input
Record<string, unknown>
Returns
object
input
input:
Record<string,unknown>
#fetch?
optionalfetch?: {(input,init?):Promise<Response>; (input,init?):Promise<Response>; }
Defined in: loaders.ts:10
#Call Signature
(
input,init?):Promise<Response>
Parameters
input
RequestInfo | URL
init?
RequestInit
Returns
Promise<Response>
#Call Signature
(
input,init?):Promise<Response>
Parameters
input
string | Request | URL
init?
RequestInit
Returns
Promise<Response>
#Inherited from
#filter?
optionalfilter?: (key) =>boolean
Defined in: loaders.ts:190
Include only keys matching this predicate after listing.
#Parameters
key
string
#Returns
boolean
#maxFiles?
optionalmaxFiles?:number
Defined in: loaders.ts:192
Cap on number of objects to load. Default 100.
#prefix?
optionalprefix?:string
Defined in: loaders.ts:188
Limit to keys under this prefix.