ddragon

ddragon api for League of Legends.

Usage

import { Ddragon } from "@lolmath/ddragon";

const dd = new Ddragon({
  version: "6.24.1", // defaults to 8.9.1
  language: "ja_JP", // defaults to en_US
  dataBaseUrl: "https://ddragon.leagueoflegends.com/cdn" // defaults to https://ddragon.leagueoflegends.com/cdn
  imageBaseUrl: "https://ddragon.leagueoflegends.com/cdn" // defaults to https://ddragon.leagueoflegends.com/cdn
  imageUrlTransformer: (url) => url // defaults to (url) => url
});

dd.images.splash("Cassiopeia", 0); // https://ddragon.leagueoflegends.com/cdn/img/champion/splash/Cassiopeia_0.jpg

Global

import { ddragon } from "ddragon/global";

ddragon.configure({
  version: "6.24.1",
});

ddragon.images.splash("Cassiopeia", 0); // https://ddragon.leagueoflegends.com/cdn/img/champion/splash/Cassiopeia_0.jpg

Webp

import { Ddragon, withWebp } from "@lolmath/ddragon";

const dd = new Ddragon(withWebp());

dd.images.splash("Cassiopeia", 0); // https://ddragon-webp.lolmath.net/img/champion/centered/Cassiopeia_0.webp

Docs

Documentation can be found at https://docs.lolmath.net/ddragon

Interfaces

DdragonOptions

Defined in: index.ts:30

Properties

dataBaseUrl?

optional dataBaseUrl: string;

Defined in: index.ts:34

imageBaseUrl?

optional imageBaseUrl: string;

Defined in: index.ts:33

imageUrlTransformer()?

optional imageUrlTransformer: (url) => string;

Defined in: index.ts:35

Parameters

Parameter	Type
`url`	`string`

Returns

string

language?

optional language: Language;

Defined in: index.ts:32

version?

optional version: string;

Defined in: index.ts:31

Type Aliases

Language

type Language = 
  | "en_US"
  | "cs_CZ"
  | "de_DE"
  | "el_GR"
  | "en_AU"
  | "en_GB"
  | "en_PH"
  | "en_SG"
  | "es_AR"
  | "es_ES"
  | "es_MX"
  | "fr_FR"
  | "hu_HU"
  | "id_ID"
  | "it_IT"
  | "ja_JP"
  | "ko_KR"
  | "pl_PL"
  | "pt_BR"
  | "ro_RO"
  | "ru_RU"
  | "th_TH"
  | "tr_TR"
  | "vn_VN"
  | "zh_CN"
  | "zh_MY"
  | "zh_TW";

Defined in: index.ts:1

Functions

createDdragon()

function createDdragon(options?): object;

Defined in: index.ts:43

Parameters

Parameter	Type
`options?`	`DdragonOptions`

Returns

object

Name	Type	Description	Defined in
`configure()`	(`__namedParameters`) => `void`	-	index.ts:225
`data`	`object`	-	index.ts:227
`data.champion()`	(`name`) => `string`	-	index.ts:193
`data.language()`	() => `string`	-	index.ts:205
`champions()`	() => `string`	-	index.ts:196
`championsFull()`	() => `string`	-	index.ts:199
`dragontail()`	() => `string`	A compressed tarball (.tgz) which will contain all assets for a patch.	index.ts:184
`item()`	() => `string`	-	index.ts:202
`languages()`	() => `string`	All supported languages.	index.ts:190
`map()`	() => `string`	-	index.ts:207
`missionAssets()`	() => `string`	-	index.ts:210
`profileicon()`	() => `string`	-	index.ts:213
`runes()`	() => `string`	-	index.ts:216
`summoner()`	() => `string`	-	index.ts:219
`versions()`	() => `string`	You can find all valid Data Dragon versions in the versions file. Typically there's only a single build of Data Dragon for a given patch, however occasionally there will be additional builds. This typically occurs when there's an error in the original build. As such, you should always use the most recent Data Dragon version for a given patch for the best results. The latest version is always the first element in the array.	index.ts:178
`images`	`object`	-	index.ts:226
`images.item()`	(`full`) => `string`	-	index.ts:117
`centered()`	(`name`, `num`) => `string`	Get the champion centered image of a champion + skin	index.ts:104
`champion()`	(`full`) => `string`	A champion square	index.ts:112
`loading()`	(`name`, `num`) => `string`	Gets the loading image of a champion + skin	index.ts:88
`map()`	(`full`) => `string`	-	index.ts:122
`mission()`	(`full`) => `string`	-	index.ts:127
`passive()`	(`full`) => `string`	-	index.ts:132
`profileicon()`	(`full`) => `string`	-	index.ts:137
`rune()`	(`icon`) => `string`	-	index.ts:155
`spell()`	(`full`) => `string`	-	index.ts:142
`splash()`	(`name`, `num`) => `string`	Gets the splash image of a champion + skin	index.ts:80
`sprite()`	(`sprite`) => `string`	-	index.ts:150
`statMod()`	(`statName`) => `string`	A stat rune	index.ts:161
`summoner()`	(`full`) => `string`	-	index.ts:147
`tile()`	(`name`, `num`) => `string`	Get the champion tile of a champion + skin	index.ts:96

withWebp()

function withWebp(options?): DdragonOptions;

Defined in: index.ts:231

Parameters

Parameter	Type
`options?`	`Omit`<`DdragonOptions`, `"imageBaseUrl"` \| `"imageUrlTransformer"`>

Returns

DdragonOptions

@lolmath/ddragon

On this page