iwf
    Preparing search index...

    Class Reference

    A class for References.

    Index
    • Parameters

      • reference: {
            hash?: string;
            snaks: z.ZodRecord<
                z.ZodString,
                z.ZodArray<
                    z.ZodUnion<
                        readonly [
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"commonsMedia">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"globe-coordinate">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"monolingualtext">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"quantity">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"string">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"time">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"url">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"wikibase-item">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"external-id">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"geo-shape">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"math">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"tabular-data">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"musical-notation">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"wikibase-property">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"wikibase-lexeme">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"wikibase-sense">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"entity-schema">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                            z.ZodObject<
                                {
                                    datatype: z.ZodOptional<z.ZodLiteral<"wikibase-form">>;
                                    datavalue: z.ZodOptional<
                                        z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                    >;
                                    hash: z.ZodOptional<z.ZodString>;
                                    property: z.ZodString;
                                    snaktype: z.ZodEnum<
                                        { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                    >;
                                },
                                z.core.$strip,
                            >,
                        ],
                    >,
                >,
            >;
            "snaks-order"?: string[];
        }

        The Reference in JSON format.

      Returns Reference

      If reference fields or nested snaks fail Wikidata schema validation.

      const reference = new Reference(json);
      
    hash: string | undefined
    snaks: Snak[]
    snaksOrder: string[] | undefined
    • get internalID(): string

      Creates a unique ID for the Reference.

      Returns string

      The ID.

    • Checks if References are equal.

      Parameters

      Returns boolean

      True if the References are equal.

      const reference = Reference.fromSnaks([
      new Snak('P123', 'Q42'),
      new Snak('P456', 'Q43')
      ]);

      const reference2 = Reference.fromSnaks([
      new Snak('P123', 'Q42')
      ]);

      reference.equals(reference2); // false
    • Returns {
          hash?: string;
          snaks: z.ZodRecord<
              z.ZodString,
              z.ZodArray<
                  z.ZodUnion<
                      readonly [
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"commonsMedia">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"globe-coordinate">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"monolingualtext">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"quantity">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"string">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"time">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"url">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"wikibase-item">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"external-id">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"geo-shape">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"math">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"tabular-data">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"musical-notation">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"wikibase-property">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"wikibase-lexeme">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"wikibase-sense">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"entity-schema">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                          z.ZodObject<
                              {
                                  datatype: z.ZodOptional<z.ZodLiteral<"wikibase-form">>;
                                  datavalue: z.ZodOptional<
                                      z.ZodObject<{ type: ...; value: ... }, z.core.$strip>,
                                  >;
                                  hash: z.ZodOptional<z.ZodString>;
                                  property: z.ZodString;
                                  snaktype: z.ZodEnum<
                                      { novalue: "novalue"; somevalue: "somevalue"; value: "value" },
                                  >;
                              },
                              z.core.$strip,
                          >,
                      ],
                  >,
              >,
          >;
          "snaks-order"?: string[];
      }

      The Reference in a JSON format.

      const json = reference.toJSON();
      
    • Creates a new Reference from snaks.

      Parameters

      • snaks: Snak[]

        The snaks for the Reference.

      Returns Reference

      The Reference object.

      const reference = Reference.fromSnaks([
      new Snak('P123', 'Q42'),
      new Snak('P456', 'Q43')
      ]);