planetside_api

0.2.0

A wrapper for the PlanetSide 2 API and Event Streaming service for Elixir.

HexDocs

Current section

Files

Jump to

planetside_api lib ps2 api query_result.ex

Raw

lib/ps2/api/query_result.ex

defmodule PS2.API.QueryResult do
	defstruct data: [], returned: 0

	@type t() :: %__MODULE__{
		data: list() | map(),
		returned: integer()
	}
end

Type any of these into the search box. They can be combined with free text which searches package names and descriptions.

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT

Wrap values in double quotes to include spaces, e.g. name:"my package".