NameMC | namemcwrapper

Hierarchy

DataParser
- NameMC

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NameMC(options?: IOptions): NameMC

Overrides DataParser.constructor
- Defined in index.ts:86
Parameters
- options: IOptions = {}
Returns NameMC

Properties

Readonly api

api: API

Class for API Requests

Readonly options

options: Options

Parameters passed to the constructor during class initialization

Methods

checkServerLike

checkServerLike(__namedParameters: ICheckServerLikeOptions): Promise<boolean>

- Defined in index.ts:318
Check server like value by username

Parameters
- __namedParameters: ICheckServerLikeOptions
Returns Promise<boolean>

getCapeInfo

getCapeInfo(hash: CapeHash): CapeContext

- Defined in index.ts:169
Get cape info by cape hash

Parameters
- hash: CapeHash
Returns CapeContext

getFriends

getFriends(username: string): Promise<IFriend[]>

- Defined in index.ts:179
Get player friends by nickname

Parameters
- username: string
Returns Promise<IFriend[]>

getPlayer

getPlayer(username: string): Promise<PlayerContext>

- Defined in index.ts:129
Get player info by nickname

Parameters
- username: string
Returns Promise<PlayerContext>

getRenders

getRenders(options: Omit<IRendersContextOptions, keyof IContextOptions<any>>): RendersContext

- Defined in index.ts:145
Get skin renders

Parameters
- options: Omit<IRendersContextOptions, keyof IContextOptions<any>>
Returns RendersContext

getServer

getServer(ip: string): Promise<ServerContext>

- Defined in index.ts:293
Get server by ip

Parameters
- ip: string
Returns Promise<ServerContext>

getServerLikes

getServerLikes(ip: string): Promise<string[]>

- Defined in index.ts:309
Get server likes by ip

Parameters
- ip: string
Returns Promise<string[]>

getServers

getServers(page?: number): Promise<ServerContext[]>

- Defined in index.ts:277
Get servers list

Parameters
- page: number = 1
Returns Promise<ServerContext[]>

getSkin

getSkin(id: string): Promise<SkinContext>

- Defined in index.ts:261
Get information about skin

Parameters
- id: string
Returns Promise<SkinContext>

getSkins

getSkins(options: IGetSkinsOptions<"new", undefined, number>): Promise<SkinContext[]>
getSkins(options: IGetSkinsOptions<"tag", undefined, number>): Promise<SkinContext[]>
getSkins(options: IGetSkinsOptions<"tag", string, number>): Promise<SkinContext[]>
getSkins(options: IGetSkinsOptions<"trending", "daily", number>): Promise<SkinContext[]>
getSkins(options: IGetSkinsOptions<"trending", "weekly", number>): Promise<SkinContext[]>
getSkins(options: IGetSkinsOptions<"trending", "monthly", number>): Promise<SkinContext[]>
getSkins(options: IGetSkinsOptions<"trending", "top", number>): Promise<SkinContext[]>
getSkins(options: IGetSkinsOptions<"random", undefined, number>): Promise<SkinContext[]>

- Defined in index.ts:195
Get new skins

see
NameMC New Skins

Parameters
- options: IGetSkinsOptions<"new", undefined, number>
Returns Promise<SkinContext[]>
- Defined in index.ts:201
Get skins tags

see
NameMC Tagged Skins

Parameters
- options: IGetSkinsOptions<"tag", undefined, number>
Returns Promise<SkinContext[]>
- Defined in index.ts:207
Get skins by tag

see
NameMC Girl Tag Skins

Parameters
- options: IGetSkinsOptions<"tag", string, number>
Returns Promise<SkinContext[]>
- Defined in index.ts:213
Get daily trending skins

see
NameMC Daily Trending Skins

Parameters
- options: IGetSkinsOptions<"trending", "daily", number>
Returns Promise<SkinContext[]>
- Defined in index.ts:219
Get weekly trending skins

see
NameMC Weekly Trending Skins

Parameters
- options: IGetSkinsOptions<"trending", "weekly", number>
Returns Promise<SkinContext[]>
- Defined in index.ts:225
Get monthly trending skins

see
NameMC Monthly Trending Skins

Parameters
- options: IGetSkinsOptions<"trending", "monthly", number>
Returns Promise<SkinContext[]>
- Defined in index.ts:231
Get top trending skins

see
NameMC Top Trending Skins

Parameters
- options: IGetSkinsOptions<"trending", "top", number>
Returns Promise<SkinContext[]>
- Defined in index.ts:237
Get random skins

see
NameMC Random Skins

Parameters
- options: IGetSkinsOptions<"random", undefined, number>
Returns Promise<SkinContext[]>

search

search(query: string): Promise<PlayerContext | ServerContext | SearchContext>

- Defined in index.ts:331
Search

Parameters
- query: string
Returns Promise<PlayerContext | ServerContext | SearchContext>

skinHistory

skinHistory(__namedParameters: IGetSkinHistoryOptions): Promise<SkinContext[]>

- Defined in index.ts:107
Get skin history by nickname

Parameters
- __namedParameters: IGetSkinHistoryOptions
Returns Promise<SkinContext[]>

transformSkin

transformSkin(__namedParameters: ITransformSkinOptions): Promise<SkinContext>

- Defined in index.ts:155
Transform skin method

Parameters
- __namedParameters: ITransformSkinOptions
Returns Promise<SkinContext>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: IOptions = {}

Returns NameMC

Properties

Readonly api

Readonly options

Methods

checkServerLike

Parameters

__namedParameters: ICheckServerLikeOptions

Returns Promise<boolean>

getCapeInfo

Parameters

hash: CapeHash

Returns CapeContext

getFriends

Parameters

username: string

Returns Promise<IFriend[]>

getPlayer

Parameters

username: string

Returns Promise<PlayerContext>

getRenders

Parameters

options: Omit<IRendersContextOptions, keyof IContextOptions<any>>

Returns RendersContext

getServer

Parameters

ip: string

Returns Promise<ServerContext>

getServerLikes

Parameters

ip: string

Returns Promise<string[]>

getServers

Parameters

page: number = 1

Returns Promise<ServerContext[]>

getSkin

Parameters

id: string

Returns Promise<SkinContext>

getSkins

Parameters

options: IGetSkinsOptions<"new", undefined, number>

Returns Promise<SkinContext[]>

Parameters

options: IGetSkinsOptions<"tag", undefined, number>

Returns Promise<SkinContext[]>

Parameters

options: IGetSkinsOptions<"tag", string, number>

Returns Promise<SkinContext[]>

Parameters

options: IGetSkinsOptions<"trending", "daily", number>

Returns Promise<SkinContext[]>

Parameters

options: IGetSkinsOptions<"trending", "weekly", number>

Returns Promise<SkinContext[]>

Parameters

options: IGetSkinsOptions<"trending", "monthly", number>

Returns Promise<SkinContext[]>

Parameters

options: IGetSkinsOptions<"trending", "top", number>

Returns Promise<SkinContext[]>

Parameters

options: IGetSkinsOptions<"random", undefined, number>

Returns Promise<SkinContext[]>

search

Parameters

query: string

Returns Promise<PlayerContext | ServerContext | SearchContext>

skinHistory