NPM.Search (NPM v0.6.0)

Copy Markdown View Source

Local search functionality for installed packages.

Searches package names, descriptions, and keywords in the installed node_modules.

Summary

Functions

Filters search results by minimum score.

Scores a package against a search query.

Searches installed packages matching a query string.

Types

search_result()

@type search_result() :: %{
  name: String.t(),
  version: String.t(),
  description: String.t() | nil,
  keywords: [String.t()],
  score: float()
}

Functions

filter_by_score(results, min_score)

@spec filter_by_score([search_result()], float()) :: [search_result()]

Filters search results by minimum score.

score(pkg_info, query)

@spec score(map(), String.t()) :: float()

Scores a package against a search query.

Returns a score from 0.0 to 1.0 based on match quality.

search(node_modules_dir, query)

@spec search(String.t(), String.t()) :: [search_result()]

Searches installed packages matching a query string.

Matches against package name, description, and keywords. Results are sorted by relevance score.