crawfishcloud

Index

Namespaces

crawfishTypes

Properties

default

Functions

Properties

default

default: CrawfishCloud

Functions

Const asS3

asS3(o: S3Item, i: number): Promise<S3Item>

- Defined in src/exporters.ts:18
Parameters
- o: S3Item
- i: number
Returns Promise<S3Item>

Const asVfile

asVfile(o: S3Item, i: number): Promise<VFile>

- Defined in src/exporters.ts:20
Parameters
- o: S3Item
- i: number
Returns Promise<VFile>

Const asVinyl

asVinyl(o: S3Item, i: number): Promise<File>

- Defined in src/exporters.ts:38
Parameters
- o: S3Item
- i: number
Returns Promise<File>

Const crawler

crawler(input: { body?: boolean; maxkeys?: number; s3c: S3 }, ...filters: string[]): CrawfishCloudReturnNoProto

- Defined in src/crawfishcloud.ts:26
The crawler takes a base config of your S3Client object, and some base configs, that setup your defaults for the crawler.
todo
- code to help lack of acccess to S3
example
```
import crawler from 'crawfishcloud'
import {S3, SharedIniFileCredentials} from 'aws-sdk'
const credentials = new SharedIniFileCredentials({profile:'default'})
const s3c = new S3({credentials, region:'us-west-2'})
const crab = crawler({s3c}, 's3://ericdmoore.com-images/*.jpg')
const ret = await crab.vfileArray()
```
Parameters
- input: { body?: boolean; maxkeys?: number; s3c: S3 }
  - Optional body?: boolean
  - Optional maxkeys?: number
  - s3c: S3
    
    a configured S3 Client that is authorized to make calls
- Rest ...filters: string[]
  
  default set of S3 Url globs
Returns CrawfishCloudReturnNoProto

Generated using TypeDoc