Class TeeSkin6

Class used to render TW 0.6 skins (ddnet).

Index

Constructors

Properties

opts clearCache setTTL

Methods

Constructors

constructor

new TeeSkin6(options?): TeeSkin6
Construct a new TeeSkin6 instance.
Parameters
- options: TeeSkin6Options = {}
Returns TeeSkin6
- Defined in src/classes/skins/TeeSkin6.ts:89

Properties

`Readonly`opts

opts: Required<{
skinDbUrl?: string;
skinResource?: string | Buffer;
}>

Options for this instance.

Type declaration

OptionalskinDbUrl?: string
The url to query in case skinResource is a string.
Remarks
The "/" at the end of the url is important.
Default
```
"https://skins.scrumplex.net/skin/"
```
OptionalskinResource?: string | Buffer
The resource to use, pass a Buffer for loading local custom skins, otherwise a skin name.
Default
```
"default"
```

`Static`clearCache

clearCache: (() => Promise<void>) = ...

Clears the TeeSkin6.cache.

Type declaration

- (): Promise<void>
- Clears the CacheManager.store.
  
  Returns Promise<void>

`Static`setTTL

setTTL: ((ttlMS?: number) => void) = ...

Sets the TTL (Time-To-Live) for objects in cache.

Type declaration

- (ttlMS?): void
- Sets the CacheManager.ttl.
  Parameters
  - OptionalttlMS: number
    If provided, sets the CacheManager.ttl to this value, otherwise uses the default value.
  Returns void

Methods

render

render(options?): Promise<Buffer>
Renders a tee image.
Parameters
- options: TeeSkinRenderOptions = {}
  Render options to use.
Returns Promise<Buffer>
- Defined in src/classes/skins/TeeSkin6.ts:150