Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeusJunior committed Oct 27, 2023
1 parent c850b03 commit f49abb1
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# node-tf2-backpack
Typed module to parse the `backpack` property from [node-tf2](https://github.com/DoctorMcKay/node-tf2).
Using this you no longer have to retrieve your own (bots) backpack from the steam API, which has been having issues with increasing ratelimits.
Typed module to parse inventory items from [node-tf2](https://github.com/DoctorMcKay/node-tf2)
Using this you no longer have to retrieve your own (bots) backpack from the steam API, which has been having issues with increasing ratelimits.

# Installation
```
Expand Down Expand Up @@ -41,6 +41,7 @@ parseItem(item: BackpackEntry, mapToString = false): Item<string | number> {}
- `item` - `item` from node-tf2's `itemAcquired`/`itemChanged`/`itemRemoved` events. See [the docs](https://github.com/DoctorMcKay/node-tf2#itemacquired).
- `mapToString` - set to true to return spells, parts, sheen, killstreaker, killstreakTier and wear as names instead of IDs
- Returns `Item<string | number>`

Exactly the same as parseBackpack but for a single item for convenience

## Other
Expand Down

0 comments on commit f49abb1

Please sign in to comment.