Class FacetGroup

Represents a group of Facets

Facets in a group are combined with an OR operation

Example

// FacetGroup with the version "1.16.5" or "1.17.1"
new FacetGroup(
  // Combined with OR
  new Facet(FacetType.Versions, FacetOperation.EQUALS, "1.16.5"),
  new Facet(FacetType.Versions, FacetOperation.EQUALS, "1.17.1")
);

Constructors

constructor

Methods

addFacet getFacets stringify

Constructors

constructor

  • new FacetGroup(...facets: Facet[]): FacetGroup

    Creates a new FacetGroup with the given facets. Facets in a group are combined with an OR operation

    Parameters

    • ...facets: Facet[]

      The facets to create the group with

    Returns FacetGroup

    Example

    // FacetGroup with the version "1.16.5" or "1.17.1"
    new FacetGroup(
      // Combined with OR
      new Facet(FacetType.Versions, FacetOperation.EQUALS, "1.16.5"),
      new Facet(FacetType.Versions, FacetOperation.EQUALS, "1.17.1")
    )

Methods

addFacet

getFacets

  • getFacets(): Facet[]

    Gets the facets

    Returns Facet[]

    The facets

stringify

  • stringify(): string

    Stringifies the facet group

    Returns string

    The stringified facet group (e.g. ["categories:forge"] or ["versions:1.16.5", "versions:1.17.1"])

Settings

Member Visibility

On This Page

Constructors
Methods