Class CS2Inspect

Main CS2 Inspect URL API class

Constructors

constructor

new CS2Inspect(config?): CS2Inspect
Parameters
- config: CS2InspectConfig = {}
Returns CS2Inspect
- Defined in index.ts:87

Methods

createInspectUrl

createInspectUrl(item): string
Creates an inspect URL from an EconItem
Parameters
- item: EconItem
  The item data to encode
Returns string
The generated inspect URL
- Defined in index.ts:99

decodeMaskedUrl

decodeMaskedUrl(url): EconItem
Decodes a MASKED inspect URL into an EconItem (synchronous, offline)

Only works with MASKED URLs (URLs containing encoded protobuf data). Does NOT work with UNMASKED URLs (market/inventory links) - use inspectItem() instead.
Parameters
- url: string
  The MASKED inspect URL to decode
Returns EconItem
The decoded item data

Throws
Error if URL is unmasked or invalid
- Defined in index.ts:113

decodeInspectUrl

decodeInspectUrl(url): EconItem
Decodes a MASKED inspect URL into an EconItem (synchronous, offline)
Parameters
- url: string
  The MASKED inspect URL to decode
Returns EconItem
The decoded item data

Deprecated
Use decodeMaskedUrl() instead for clearer naming
- Defined in index.ts:125

analyzeUrl

analyzeUrl(url): AnalyzedInspectURL
Analyzes an inspect URL structure
Parameters
- url: string
  The URL to analyze
Returns AnalyzedInspectURL
Analyzed URL information
- Defined in index.ts:135

validateItem

validateItem(item): ValidationResult
Validates an EconItem
Parameters
- item: any
  The item to validate
Returns ValidationResult
Validation result
- Defined in index.ts:145

validateUrl

validateUrl(url): ValidationResult
Validates an inspect URL
Parameters
- url: string
  The URL to validate
Returns ValidationResult
Validation result
- Defined in index.ts:155

isValidUrl

isValidUrl(url): boolean
Checks if a URL is a valid inspect URL
Parameters
- url: string
  The URL to check
Returns boolean
True if valid, false otherwise

Deprecated
Use analyzeUrl() and check for errors instead, or use validateUrl() for detailed validation
- Defined in index.ts:166

normalizeUrl

normalizeUrl(url): string
Normalizes an inspect URL to standard format
Parameters
- url: string
  The URL to normalize
Returns string
Normalized URL
- Defined in index.ts:181

getUrlInfo

getUrlInfo(url): {
    type: "masked" | "unmasked" | "invalid";
    isQuoted: boolean;
    hasValidFormat: boolean;
    estimatedSize?: number;
}
Gets basic URL information without full decoding
Parameters
- url: string
  The URL to analyze
Returns {
    type: "masked" | "unmasked" | "invalid";
    isQuoted: boolean;
    hasValidFormat: boolean;
    estimatedSize?: number;
}
Basic URL information
- type: "masked" | "unmasked" | "invalid"
- isQuoted: boolean
- hasValidFormat: boolean
- Optional estimatedSize?: number
- Defined in index.ts:191

inspectItem

inspectItem(url): Promise<EconItem | SteamInspectResult>
Inspects ANY inspect URL (both masked and unmasked) - Universal method

Works with MASKED URLs (decoded offline using protobuf data) and UNMASKED URLs (fetched via Steam client). Automatically detects URL type.
Parameters
- url: string
  Any valid inspect URL (masked or unmasked)
Returns Promise<EconItem | SteamInspectResult>
Promise resolving to the decoded item data

Throws
Error if Steam client is required but not available
- Defined in index.ts:205

decodeInspectUrlAsync

decodeInspectUrlAsync(url): Promise<EconItem | SteamInspectResult>
Inspects ANY inspect URL (both masked and unmasked) - Universal method
Parameters
- url: string
  Any valid inspect URL (masked or unmasked)
Returns Promise<EconItem | SteamInspectResult>
Promise resolving to the decoded item data

Deprecated
Use inspectItem() instead for clearer naming
- Defined in index.ts:255

initializeSteamClient

initializeSteamClient(): Promise<void>
Initialize Steam client for unmasked URL support

Returns Promise<void>
Promise that resolves when Steam client is ready
- Defined in index.ts:264

isSteamClientReady

isSteamClientReady(): boolean
Check if Steam client is available and ready

Returns boolean
True if Steam client is ready for inspection
- Defined in index.ts:273

getSteamClientStats

getSteamClientStats(): {
    status: SteamClientStatus;
    queueLength: number;
    isAvailable: boolean;
    unmaskedSupport: boolean;
}
Get Steam client status and statistics

Returns {
    status: SteamClientStatus;
    queueLength: number;
    isAvailable: boolean;
    unmaskedSupport: boolean;
}
Steam client status information
- status: SteamClientStatus
- queueLength: number
- isAvailable: boolean
- unmaskedSupport: boolean
- Defined in index.ts:282

getSteamClientManager

getSteamClientManager(): SteamClientManager
Get the SteamClientManager instance (for use with convenience functions)

Returns SteamClientManager
The SteamClientManager instance
- Defined in index.ts:291

requiresSteamClient

requiresSteamClient(url): boolean
Check if a URL requires Steam client for inspection
Parameters
- url: string
  The URL to check
Returns boolean
True if URL requires Steam client
- Defined in index.ts:301

disconnectSteamClient

disconnectSteamClient(): Promise<void>
Disconnect Steam client

Returns Promise<void>
- Defined in index.ts:308

updateConfig

updateConfig(newConfig): void
Updates the configuration
Parameters
- newConfig: Partial<CS2InspectConfig>
  New configuration options
Returns void
- Defined in index.ts:317

getConfig

getConfig(): Required<CS2InspectConfig>
Gets current configuration

Returns Required<CS2InspectConfig>
Current configuration
- Defined in index.ts:338

Class CS2Inspect

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CS2Inspect

Methods

createInspectUrl

Parameters

Returns string

decodeMaskedUrl

Parameters

Returns EconItem

Throws

decodeInspectUrl

Parameters

Returns EconItem

Deprecated

analyzeUrl

Parameters

Returns AnalyzedInspectURL

validateItem

Parameters

Returns ValidationResult

validateUrl

Parameters

Returns ValidationResult

isValidUrl

Parameters

Returns boolean

Deprecated

normalizeUrl

Parameters

Returns string

getUrlInfo

Parameters

Returns { type: "masked" | "unmasked" | "invalid"; isQuoted: boolean; hasValidFormat: boolean; estimatedSize?: number; }

type: "masked" | "unmasked" | "invalid"

isQuoted: boolean

hasValidFormat: boolean

Optional estimatedSize?: number

inspectItem

Parameters

Returns Promise<EconItem | SteamInspectResult>

Throws

decodeInspectUrlAsync

Parameters

Returns Promise<EconItem | SteamInspectResult>

Deprecated

initializeSteamClient

Returns Promise<void>

isSteamClientReady

Returns boolean

getSteamClientStats

Returns { status: SteamClientStatus; queueLength: number; isAvailable: boolean; unmaskedSupport: boolean; }

status: SteamClientStatus

queueLength: number

isAvailable: boolean

unmaskedSupport: boolean

getSteamClientManager

Returns SteamClientManager

requiresSteamClient

Parameters

Returns boolean

disconnectSteamClient

Returns Promise<void>

updateConfig

Parameters

Returns void

getConfig

Returns Required<CS2InspectConfig>

Settings

Member Visibility

Theme

On This Page

Returns {
type: "masked" | "unmasked" | "invalid";
isQuoted: boolean;
hasValidFormat: boolean;
estimatedSize?: number;
}

`Optional` estimatedSize?: number

Returns {
status: SteamClientStatus;
queueLength: number;
isAvailable: boolean;
unmaskedSupport: boolean;
}