PS2.API.Query.Join (PlanetSide 2 API v1.0.0)

View Source

A data structure representing a join on an API query. Create a join using %PS2.API.Query.Join{} or the new/0 or new/1 functions.

Summary

Types

opts()
t()

Functions

new()
new(opts)

Types

opts()

@type opts() :: [
  collection: String.t(),
  on: String.t(),
  to: String.t(),
  list: boolean(),
  show: [term()],
  hide: [term()],
  inject_at: String.t(),
  outer: boolean()
]

t()

@type t() :: %PS2.API.Query.Join{
  collection: String.t() | nil,
  joins: [t()],
  params: map()
}

Functions

new()

@spec new() :: t()

new(opts)

@spec new(opts()) :: t()