StarTransaction Class

extends Base

Properties

  • amount: number
  • client: Client
  • date: Date
  • id: string
  • source: any

Methods

{
  "id": 1826,
  "name": "StarTransaction",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "children": [
    {
      "id": 1827,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StarTransaction.ts",
          "line": 22,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1828,
          "name": "new StarTransaction",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/StarTransaction.ts",
              "line": 22,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1829,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1830,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1826,
            "name": "StarTransaction",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1832,
      "name": "amount",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Number of Telegram Stars transferred by the transaction"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StarTransaction.ts",
          "line": 14,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1835,
      "name": "client",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isInherited": true
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Base.ts",
          "line": 4,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1,
        "name": "Client",
        "package": "tgkit",
        "qualifiedName": "default"
      },
      "inheritedFrom": {
        "type": "reference",
        "target": -1,
        "name": "Base.client"
      }
    },
    {
      "id": 1833,
      "name": "date",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Date the transaction was created"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StarTransaction.ts",
          "line": 17,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": {
          "sourceFileName": "node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.es5.d.ts",
          "qualifiedName": "Date"
        },
        "name": "Date",
        "package": "typescript"
      }
    },
    {
      "id": 1831,
      "name": "id",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique identifier of the transaction. Coincides with the identifer of the original transaction\nfor refund transactions. Coincides with <SuccessfulPayment>.telegramPaymentChargeId\nfor successful incoming payments from users."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StarTransaction.ts",
          "line": 11,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1834,
      "name": "source",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/StarTransaction.ts",
          "line": 20,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "any"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1827
      ]
    },
    {
      "title": "Properties",
      "children": [
        1832,
        1835,
        1833,
        1831,
        1834
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/StarTransaction.ts",
      "line": 5,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}