Skip to content
ck edited this page Oct 6, 2024 · 1 revision

async Retrieve a wiki page or image data.

Usage example

const { auth, v2 } = require('osu-api-extended');

async function main() {
  try {
    const result = await v2.wiki.details({
      locale: 'EN',
      path_name: 'Main_page'
    });
    if (result.error != null) {
      console.log(result.error);
      return;
    };

    console.log(result);
  } catch (error) {
    console.log(error);
  };
};

main();
Parameter Type Description
params.locale string
params.path_name string
addons.legacy_only? boolean
addons.apiVersion? '20240130' '99999999'
addons.authKey? string
addons.timeout_ms? number
addons.ignoreSessionRefresh? boolean

Response

export interface WikiDetailsResponse {
  available_locales: string[]
  layout: string
  locale: string
  markdown: string
  path: string
  subtitle: any
  tags: any[]
  title: string
}

[v3.x.x] Documentation


[v2.x.x] Documentation

Clone this wiki locally