Mirrors/webamp
1
0
Fork 0
mirror of https://github.com/captbaritone/webamp.git synced 2026-01-23 02:15:01 +00:00
Code Issues Projects Releases Wiki Activity

Fix typos of Winamp when I meant Webamp

Browse source
This commit is contained in:
Jordan Eldredge 2025-06-29 14:22:19 -07:00
parent 2be1e38bce
commit ce483b8df5
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/webamp-docs/docs/06_API/02_webamp-constructor.md
View file

@ -1,6 +1,6 @@
# Webamp Constructor
The `Winamp` class is constructed with an options object. _All config properties are optional._
The `Webamp` class is constructed with an options object. _All config properties are optional._
```ts
import Webamp from "webamp";

4
packages/webamp-docs/docs/06_API/03_instance-methods.md
View file

@ -221,7 +221,7 @@ If a `domNode` is passed, Webamp will place itself in the center of that DOM nod
A promise is returned which will resolve after the render is complete.
```ts
const container = document.getElementById("winamp-container");
const container = document.getElementById("webamp-container");
webamp.renderWhenReady(container).then(() => {
console.log("rendered webamp!");
});
@ -329,7 +329,7 @@ console.log(`The skin loaded in ${Date.now() - start}`);
### `dispose(): void`
**Note:** _This method is not fully functional. It is currently impossible to clean up a Winamp instance. This method makes an effort, but it still leaks the whole instance. In the future the behavior of this method will improve, so you might as well call it._
**Note:** _This method is not fully functional. It is currently impossible to clean up a Webamp instance. This method makes an effort, but it still leaks the whole instance. In the future the behavior of this method will improve, so you might as well call it._
When you are done with a Webamp instance, call this method and Webamp will attempt to clean itself up to avoid memory leaks.