npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, πŸ‘‹, I’m Ryan HefnerΒ  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you πŸ™

Β© 2024 – Pkg Stats / Ryan Hefner

tf2-get-player-items

v0.0.6

Published

### πŸ“– Table of Contents - [πŸ‘‹ Introduction](#-introduction) - [πŸ”Œ Getting Started](#-getting-started) - [getTF2PlayerItems](#gettf2playeritems) - [The Schema](#the-schema) - [πŸ“š Helpful Resources](#-helpful-resources)

Downloads

2

Readme

node-tf2-get-player-items

πŸ“– Table of Contents

πŸ‘‹ Introduction

This module is a wrapper for the IEconItems/GetPlayerItems API specific for a user's backpack. It allows you to get the items for a player, providing game-specific item information not normally provided within the other generic inventory APIs.

πŸ”Œ Getting Started

You can install this module with npm within your project by running the command:

npm install tf2-get-player-items

getTF2PlayerItems

The module simply exports a simple function getTF2PlayerItems.

Example Usage
import { getTF2PlayerItems } from `tf2-get-player-items`;

const steamid: string = `76561198081082634`;
const steamAPIKey: string = `abcdefghijk123456`; // your Steam API key

const playerItems: TF2PlayerItemsSchema = await getTF2PlayerItems(steamid, steamAPIKey);

The Schema

The response returned from the API is a JSON object with the following structure:

{
    result: TF2PlayerItemsSchema;
}

Deconstructing this, we get the TF2PlayerItemsSchema interface.

The schema is a simple object with the following properties:

  • status: A number representing the status of the request.
  • num_backpack_slots: A number representing the number of slots in the player's backpack.
  • backpack: An array of TF2PlayerItemsSchemaItem objects.
TF2PlayerItemsSchemaItem

The TF2PlayerItemsSchemaItem interface is a simple object with the following properties:

  • id: A number representing the item's ID.
  • original_id: A number representing the item's original ID.
  • defindex: A number representing the item's defindex.
  • level: A number representing the item's level.
  • quality: A number representing the item's quality.
  • inventory: See Inventory Token
  • quantity: A number representing the item's quantity.
  • origin?: An integer representing the item's origin.
  • style?: A number representing the item's style.
  • equipped?: Represents the item's equipped status.
    • class: A number representing the item's class.
    • slot: A number representing the item's slot.
  • flag_cannot_trade?: A boolean representing whether or not the item cannot be traded.
  • flag_cannot_craft?: A boolean representing whether or not the item cannot be crafted.
  • custom_name: A string representing the item's custom name.
  • custom_desc: A string representing the item's custom description.
  • contained_item: A TF2PlayerItemsSchemaItem representing the item's contained item.
  • attributes: An array representing the item's attributes.
    • defindex: A number representing the attribute's defindex.
    • value: A number representing the attribute's value.
    • float_value?: A number representing the attribute's float value.
    • account_info: Represents account info associated with an attribute
      • steamid: A string representing the attribute's account ID.
      • personaname: A string representing the attribute's account name.

πŸ“š Helpful Resources