Class VulnerabilityResource

Represents a single OSV vulnerability resource, identified by its OSV ID.

Implements PromiseLike<OsvVulnerability> so it can be awaited directly to fetch the vulnerability, while also acting as a resource handle.

Example

// Await directly
const vuln = await osv.vuln('GHSA-jfh8-c2jp-hdp8');

// Or call get() explicitly
const vuln = await osv.vuln('GHSA-jfh8-c2jp-hdp8').get();

Implements

Methods

get then

Methods

get

  • get(): Promise<OsvVulnerability>

    Fetches the full vulnerability record for this OSV ID.

    GET /v1/vulns/{id}

    Returns Promise<OsvVulnerability>

    The full OSV vulnerability object

    Example

    const vuln = await osv.vuln('GHSA-jfh8-c2jp-hdp8').get();
    console.log(vuln.summary);
    console.log(vuln.affected?.map(a => a.package.name));

then

Settings

Member Visibility

On This Page

Methods