Class Post

An image from a booru with a few common props

Example

Post {
 fileUrl: 'https://aaaa.com/image.jpg',
 id: '124125',
 tags: ['cat', 'cute'],
 score: 5,
 source: 'https://giraffeduck.com/aaaa.png',
 rating: 's'
}

Constructors

constructor

new Post(data, booru): Post
Create an image from a booru
Parameters
- data: any
  The raw data from the Booru
- booru: BooruClass
  The booru that created the image
Returns Post
- Defined in src/structures/Post.ts:193

Properties

available

available: boolean

If this post is available (ie. not deleted, not banned, has file url)

booru

booru: BooruClass

The Booru it came from

`Optional` createdAt

createdAt?: null | Date

The Date this post was created at

`Private` data

data: any

All the data given by the booru

fileUrl

fileUrl: null | string

The direct link to the file

height

height: number

The height of the file

id

id: string

The id of this post

previewHeight

previewHeight: null | number

The height of the smallest image (if available)

previewUrl

previewUrl: null | string

The url to the smallest image (if available)

previewWidth

previewWidth: null | number

The width of the smallest image (if available)

rating

rating: string

The rating of the image, as just the first letter (s/q/e/u) => safe/questionable/explicit/unrated

sampleHeight

sampleHeight: null | number

The height of the medium-sized image (if available)

sampleUrl

sampleUrl: null | string

The url to the medium-sized image (if available)

sampleWidth

sampleWidth: null | number

The width of the medium-sized image (if available)

score

score: number

The score of this post

`Optional` source

source?: string | string[]

The source of this post, if available

width

width: number

The width of the file

Accessors

aspectRatio

get aspectRatio(): number
The aspect ratio of this post: width / height

Returns number
- Defined in src/structures/Post.ts:322

createdTime

get createdTime(): string
The formatted created time of this post

Returns string
- Defined in src/structures/Post.ts:390

fileDownloadName

get fileDownloadName(): string
The original file download name of this post

Returns string
- Defined in src/structures/Post.ts:386

fileDownloadText

get fileDownloadText(): string
The original file download text of this post

Returns string
- Defined in src/structures/Post.ts:382

fileExt

get fileExt(): string
The file extension of this post

Returns string
- Defined in src/structures/Post.ts:338

fileSize

get fileSize(): number
The file size url of this post

Returns number
- Defined in src/structures/Post.ts:350

fileSizeText

get fileSizeText(): string
The original image file size of this post

Returns string
- Defined in src/structures/Post.ts:378

isRatingE

get isRatingE(): boolean
Is this post explicit

Returns boolean
- Defined in src/structures/Post.ts:318

isRatingQ

get isRatingQ(): boolean
Is this post questionable

Returns boolean
- Defined in src/structures/Post.ts:314

isRatingS

get isRatingS(): boolean
Is this post safe

Returns boolean
- Defined in src/structures/Post.ts:310

jpegDownloadName

get jpegDownloadName(): string
The jpeg download name of this post

Returns string
- Defined in src/structures/Post.ts:374

jpegDownloadText

get jpegDownloadText(): string
The jpeg download text of this post

Returns string
- Defined in src/structures/Post.ts:370

jpegHeight

get jpegHeight(): number
The jpeg height url of this post

Returns number
- Defined in src/structures/Post.ts:334

jpegSize

get jpegSize(): number
The jpeg size url of this post

Returns number
- Defined in src/structures/Post.ts:346

jpegSizeText

get jpegSizeText(): string
The jpeg image file size of this post

Returns string
- Defined in src/structures/Post.ts:366

jpegUrl

get jpegUrl(): string
The jpeg url of this post

Returns string
- Defined in src/structures/Post.ts:326

jpegWidth

get jpegWidth(): number
The jpeg width url of this post

Returns number
- Defined in src/structures/Post.ts:330

postView

get postView(): string

Get the post view (url to the post) of this image

Returns string

Example

const e9 = Booru('e9')
const imgs = e9.search(['cat', 'dog'])

// Log the post url of the first image
console.log(imgs[0].postView)

sampleDownloadName

get sampleDownloadName(): string
The sample download name of this post

Returns string
- Defined in src/structures/Post.ts:362

sampleDownloadText

get sampleDownloadText(): string
The sample download text of this post

Returns string
- Defined in src/structures/Post.ts:358

sampleSize

get sampleSize(): number
The sample size url of this post

Returns number
- Defined in src/structures/Post.ts:342

sampleSizeText

get sampleSizeText(): string
The sample image file size of this post

Returns string
- Defined in src/structures/Post.ts:354

sourceUrl

get sourceUrl(): string
Returns string
- Defined in src/structures/Post.ts:395

Class Post

Example

Index

Constructors

Properties

Accessors

Constructors

constructor

Parameters

Returns Post

Properties

available

booru

Optional createdAt

Private data

fileUrl

height

id

previewHeight

previewUrl

previewWidth

rating

sampleHeight

sampleUrl

sampleWidth

score

Optional source

tags

width

Accessors

aspectRatio

Returns number

createdTime

Returns string

fileDownloadName

Returns string

fileDownloadText

Returns string

fileExt

Returns string

fileSize

Returns number

fileSizeText

Returns string

isRatingE

Returns boolean

isRatingQ

Returns boolean

isRatingS

Returns boolean

jpegDownloadName

Returns string

jpegDownloadText

Returns string

jpegHeight

Returns number

jpegSize

Returns number

jpegSizeText

Returns string

jpegUrl

Returns string

jpegWidth

Returns number

postView

Returns string

Example

sampleDownloadName

Returns string

sampleDownloadText

Returns string

sampleSize

Returns number

sampleSizeText

Returns string

sourceUrl

Returns string

Settings

Member Visibility

Theme

`Optional` createdAt

`Private` data

`Optional` source