scryfall-api/devmugi.mtgcards.scryfall.js/SearchQueryBuilderJs

SearchQueryBuilderJs

class SearchQueryBuilderJs

Fluent builder for constructing Scryfall search queries in JavaScript.

Usage:

import { SearchQueryBuilderJs } from '@devmugi/scryfall-api';

const query = new SearchQueryBuilderJs()
    .type("creature")
    .color("R", "G")
    .cmcRange(2, 4)
    .isLegal("standard")
    .build();

// Use with CardsApiJs
const results = await api.search(query);

See also

Scryfall Search Syntax

Constructors

SearchQueryBuilderJs

constructor()

Functions

fun artist(name: String): SearchQueryBuilderJs

Searches for cards by artist name.

fun build(): String

Builds the final query string.

fun cmc(value: Int): SearchQueryBuilderJs

Filters by exact mana value.

fun cmcRange(min: Int? = null, max: Int? = null): SearchQueryBuilderJs

Filters by mana value range.

fun color(vararg colors: String): SearchQueryBuilderJs

Filters by exact color identity.

fun format(format: String): SearchQueryBuilderJs

Filters by format (cards printed in the format).

fun isLegal(format: String): SearchQueryBuilderJs

Filters by cards legal in a specific format.

fun keyword(keyword: String): SearchQueryBuilderJs

Filters by keyword ability.

fun name(value: String): SearchQueryBuilderJs

Adds an exact name match to the query.

fun nameContains(value: String): SearchQueryBuilderJs

Adds a partial name match to the query.

fun power(value: Int): SearchQueryBuilderJs

Filters by exact power.

fun powerRange(min: Int? = null, max: Int? = null): SearchQueryBuilderJs

Filters by power range.

fun rarity(value: String): SearchQueryBuilderJs

Filters by rarity.

fun raw(queryPart: String): SearchQueryBuilderJs

Adds a raw query string part for advanced queries.

fun set(code: String): SearchQueryBuilderJs

Filters by set code.

fun text(value: String): SearchQueryBuilderJs

Searches for text in the oracle text.

fun toughness(value: Int): SearchQueryBuilderJs

Filters by exact toughness.

fun toughnessRange(min: Int? = null, max: Int? = null): SearchQueryBuilderJs

Filters by toughness range.

fun type(value: String): SearchQueryBuilderJs

Filters by card type.