Class Article

Hierarchy

default<DBAPIArticleData>
- Article

Index

Properties

pagination serializer

Accessors

author content datePublished displayDate heroImage id image promo promoImage rawDate slug title topic

Methods

get toJSON findAll findOne

Properties

`Static`pagination

pagination: Pagination | null

`Static`serializer

serializer: (model: any) => any

serializer is a pure function that takes a model instance and returns a plain object that describes how to convert the model to JSON

Accessors

author

get author(): ArticleAuthor | null
Returns ArticleAuthor | null
- Defined in src/api/models/article.ts:174

content

get content(): string | null
Returns string | null
- Defined in src/api/models/article.ts:95

datePublished

get datePublished(): string | null
Returns string | null
- Defined in src/api/models/article.ts:113

displayDate

get displayDate(): string | null
Returns string | null
- Defined in src/api/models/article.ts:99

heroImage

get heroImage(): string | null
Returns string | null
- Defined in src/api/models/article.ts:140

id

get id(): number | null
Returns number | null
- Defined in src/api/models/article.ts:79

image

get image(): string | null
Returns string | null
- Defined in src/api/models/article.ts:125

get promo(): string | null
Returns string | null
- Defined in src/api/models/article.ts:121

promoImage

get promoImage(): string | null
Returns string | null
- Defined in src/api/models/article.ts:157

rawDate

get rawDate(): string | null
Returns string | null
- Defined in src/api/models/article.ts:109

slug

get slug(): string | null
Returns string | null
- Defined in src/api/models/article.ts:83

title

get title(): string | null
Returns string | null
- Defined in src/api/models/article.ts:87

topic

get topic(): string | null
Returns string | null
- Defined in src/api/models/article.ts:91

Methods

get

get(key: string): any
Retrieves a value from raw API data. Prioritises DBAPI data if available
Parameters
- key: string
Returns any
Inherited from Model.get
- Defined in src/api/models/model.ts:121

toJSON

toJSON(): any
Special method to define behaviour of JSON.stringify() on model instance

Returns any
Inherited from Model.toJSON
- Defined in src/api/models/model.ts:130

`Static`findAll

findAll(
    searchParams?: ArticleModelSearchParams,
): Promise<
    {
        errors: ModelError[]
        | null;
        pagination: Pagination | null;
        results: Article[];
    },
>
Parameters
- searchParams: ArticleModelSearchParams = {}
Returns Promise<
    {
        errors: ModelError[]
        | null;
        pagination: Pagination | null;
        results: Article[];
    },
>
- Defined in src/api/models/article.ts:49

`Static`findOne

findOne(
__namedParameters: { slug: string },
): Promise<{ errors: ModelError[] | null; result: Article | null }>
Parameters
- __namedParameters: { slug: string }
Returns Promise<{ errors: ModelError[] | null; result: Article | null }>
- Defined in src/api/models/article.ts:31