Class Forum

Classe représentant un forum. Utilise le site JVC.

Index

Constructors

constructor

new Forum(id: number): Forum
Crée une instance de la classe Forum.
Parameters
- id: number
  ID du forum
Returns Forum
- Defined in lib/classes/Forum.ts:26

Accessors

id

get id(): number
Renvoie l'ID du forum.

Returns number
- Defined in lib/classes/Forum.ts:150

url

get url(): string
Renvoie une URL redirigeant vers le forum.

Returns string
- Defined in lib/classes/Forum.ts:159

Methods

doesForumExist

doesForumExist(): Promise<boolean>
Renvoie un booléen à true si le forum existe, false sinon.

Returns Promise<boolean>
- Defined in lib/classes/Forum.ts:140

getConnected

getConnected(): Promise<number>
Renvoie le nombre de connectés au forum.

Returns Promise<number>
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:339

getForumTitle

getForumTitle(): Promise<string>
Renvoie le titre du forum sous forme de chaîne de caractères.

Returns Promise<string>
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:127

getStandardURL

getStandardURL(options?: { api?: boolean }): Promise<string>
Renvoie l'URL exacte du forum, obtenue après une requête à JVC.
Parameters
- Optionaloptions: { api?: boolean } = {}
  - Optionalapi?: boolean
    true pour renvoyer l'URL de l'API v4, false pour celle du site JVC (par défaut)
Returns Promise<string>
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:171

listen

listen(
options?: { raw?: boolean },
): AsyncGenerator<Topic | JVCTypes.Forum.Topic, void, unknown>
Renvoie un générateur asynchrone des nouveaux topics détectés.
Parameters
- Optionaloptions: { raw?: boolean }
  - Optionalraw?: boolean
    true pour renvoyer un objet JSON brut (JVCTypes.Forum.Topic), false pour utiliser les classes fournies par la librairie (Topic)
Returns AsyncGenerator<Topic | JVCTypes.Forum.Topic, void, unknown>
Example
```
const forum = new Forum(51);
for await (const newTopic of forum.listen()) {
     console.log(newTopic);
}
```
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:373

readTopics

readTopics(
options?: { paging?: Pagination; raw?: boolean },
): AsyncGenerator<JVCTypes.Forum.Topic[] | Topic[], void, unknown>
Renvoie un générateur asynchrone des topics postés sur le forum situés aux pages décrites par le paramètre paging.
Parameters
- Optionaloptions: { paging?: Pagination; raw?: boolean }
  - Optionalpaging?: Pagination
    objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)
  - Optionalraw?: boolean
    true pour renvoyer des objets JSON brut (JVCTypes.Forum.Topic), false pour utiliser les classes fournies par la librairie (Topic)
Returns AsyncGenerator<JVCTypes.Forum.Topic[] | Topic[], void, unknown>
Example
```
const forum = new Forum(51);
for await (const page of forum.readTopics()) {
     console.log(page);
}
```
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:249
readTopics(
options: { page: number; raw?: boolean },
): Promise<JVCTypes.Forum.Topic[] | Topic[]>
Renvoie les topics postés sur le forum situés à une page particulière.
Parameters
- options: { page: number; raw?: boolean }
  - page: number
    numéro de la page à traiter
  - Optionalraw?: boolean
    true pour renvoyer des objets JSON brut (JVCTypes.Forum.Topic), par défaut false pour utiliser les classes fournies par la librairie (Topic)
Returns Promise<JVCTypes.Forum.Topic[] | Topic[]>
Example
```
const forum = new Forum(51);
console.log(await forum.readTopics({ page: 2 }));
```
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:264

searchTopics

searchTopics(
    q: string,
    options?: {
        paging?: Pagination;
        raw?: boolean;
        searchMode?: "author" | "title";
    },
): AsyncGenerator<JVCTypes.Forum.Topic[] | Topic[], void, unknown>
Renvoie un générateur asynchrone des résultats de la recherche de topics postés sur le forum situés aux pages décrites par le paramètre paging.
Parameters
- q: string
  termes de recherche
- Optionaloptions: { paging?: Pagination; raw?: boolean; searchMode?: "author" | "title" }
  - Optionalpaging?: Pagination
    objet décrivant les pages à traiter (par défaut vide : toutes les pages le sont)
  - Optionalraw?: boolean
    true pour renvoyer des objets JSON brut (JVCTypes.Forum.Topic), false pour utiliser les classes fournies par la librairie (Topic)
  - OptionalsearchMode?: "author" | "title"
    type de recherche, par titre (défaut) ou par auteur
Returns AsyncGenerator<JVCTypes.Forum.Topic[] | Topic[], void, unknown>
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:301
searchTopics(
q: string,
options: { page: number; raw?: boolean; searchMode?: "author" | "title" },
): Promise<JVCTypes.Forum.Topic[] | Topic[]>
Renvoie les résultats de la recherche de topics postés sur le forum situés à une page particulière.
Parameters
- q: string
  termes de recherche
- options: { page: number; raw?: boolean; searchMode?: "author" | "title" }
  - page: number
    numéro de la page à traiter
  - Optionalraw?: boolean
    true pour renvoyer des objets JSON brut (JVCTypes.Forum.Topic), false pour utiliser les classes fournies par la librairie (Topic)
  - OptionalsearchMode?: "author" | "title"
    type de recherche, par titre (défaut) ou par auteur
Returns Promise<JVCTypes.Forum.Topic[] | Topic[]>
Throws
NonexistentContent si le forum n'existe pas
- Defined in lib/classes/Forum.ts:313

Class Forum

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Forum

Accessors

id

Returns number

url

Returns string

Methods

doesForumExist

Returns Promise<boolean>

getConnected

Returns Promise<number>

Throws

getForumTitle

Returns Promise<string>

Throws

getStandardURL

Parameters

Optionalapi?: boolean

Returns Promise<string>

Throws

listen

Parameters

Optionalraw?: boolean

Returns AsyncGenerator<Topic | JVCTypes.Forum.Topic, void, unknown>

Example

Throws

readTopics

Parameters

Optionalpaging?: Pagination

Optionalraw?: boolean

Returns AsyncGenerator<JVCTypes.Forum.Topic[] | Topic[], void, unknown>

Example

Throws

Parameters

page: number

Optionalraw?: boolean

Returns Promise<JVCTypes.Forum.Topic[] | Topic[]>

Example

Throws

searchTopics

Parameters

Optionalpaging?: Pagination

Optionalraw?: boolean

OptionalsearchMode?: "author" | "title"

Returns AsyncGenerator<JVCTypes.Forum.Topic[] | Topic[], void, unknown>

Throws

Parameters

page: number

Optionalraw?: boolean

OptionalsearchMode?: "author" | "title"

Returns Promise<JVCTypes.Forum.Topic[] | Topic[]>

Throws

Settings

On This Page

`Optional`api?: boolean

`Optional`raw?: boolean

`Optional`paging?: Pagination

`Optional`raw?: boolean

`Optional`raw?: boolean

`Optional`paging?: Pagination

`Optional`raw?: boolean

`Optional`searchMode?: "author" | "title"

`Optional`raw?: boolean

`Optional`searchMode?: "author" | "title"