Class DocumentPostCollection

Hierarchy

DocumentPostCollection

Index

Constructors

Properties

Methods

findByDate findById findByPreview findByTitle findByUrl toJSON fromJSON

Constructors

constructor

new DocumentPostCollection(posts: DocumentPost[]): DocumentPostCollection
Parameters
- posts: DocumentPost[]
Returns DocumentPostCollection
- Defined in src/documents/documentcollection.ts:4

Properties

`Readonly` posts

posts: DocumentPost[]

Methods

findByDate

findByDate(date: Date): DocumentPost[]
Find a certain DocumentPost by its date

Returns
An Array of DocumentsPosts
Parameters
- date: Date
  
  The date you want to search for
Returns DocumentPost[]
- Defined in src/documents/documentcollection.ts:29

findById

findById(id: string): DocumentPost[]
Find a certain DocumentPost by its id

Returns
An Array of DocumentsPosts
Parameters
- id: string
  
  The id you want to search for
Returns DocumentPost[]
- Defined in src/documents/documentcollection.ts:20

findByPreview

findByPreview(previewURL: string): DocumentPost[]
Find a certain DocumentPost by its preview url

Returns
An Array of DocumentPosts
Parameters
- previewURL: string
  
  The preview url you want to search for
Returns DocumentPost[]
- Defined in src/documents/documentcollection.ts:52

findByTitle

findByTitle(title: string): DocumentPost[]
Find a cetrtain DocumentPost by its title

Returns
An Array of DocumentsPosts
Parameters
- title: string
  
  The title you want to search for
Returns DocumentPost[]
- Defined in src/documents/documentcollection.ts:11

findByUrl

findByUrl(url: string): DocumentPost[]
Find a certain DocumentPost by its url

Returns
An Array of DocumentPosts
Parameters
- url: string
  
  The url you want to search for
Returns DocumentPost[]
- Defined in src/documents/documentcollection.ts:43

toJSON

toJSON(): object
Returns
This object as a JSON representation

Returns object
- Defined in src/documents/documentcollection.ts:59

`Static` fromJSON

fromJSON(data: object): DocumentPostCollection
Create a new instance from JSON

Returns
A new DocumentPostCollection
Parameters
- data: object
  
  The JSON data
Returns DocumentPostCollection
- Defined in src/documents/documentcollection.ts:68

Generated using TypeDoc