Pylon Logo Pylon SDK Reference
📓 Changelog 🌟 Getting Started 🧰 SDK Reference
💬 Discord Server 🏠 Home

Results

Namespace

Type

Pylon SDK Reference

If you're new to Pylon, you should check out the Getting Started section on the docs. This section serves as the Pylon SDK technical reference.

Quick Navigation

Discord SDK

Discord Command Handlers

Pylon SDK

What is this?

This reference documentation is generated from the Pylon SDK TypeScript declarations. All public methods available in the runtime that are not standard to ES2018 are documented here. It is designed to serve as a technical reference when writing scripts on the Pylon platform.

If you're looking for general documentation or examples, please check out the docs.

What's available in the Pylon runtime?

The runtime implements the standard JavaScript ES2018 library. Additionally, many methods from the Web Workers API (fetch, base64 encoding/decoding, and timers) have been implemented. Need something that the runtime doesn't offer? Let us know!

Pylon is a work-in-progress.

Although we will try our best to maintain backwards compatibility between updates, Pylon is very much still an evolving platform. If you are using Pylon during the Beta, please keep up to date with the latest changes.

Can I contribute to the documentation?

Yes! Please see our GitHub.

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

BlobPart

BlobPart: BufferSource | Blob | string

BodyInit

BodyInit: BufferSource | Blob | FormData | URLSearchParams | string

BufferSource

BufferSource: ArrayBufferView | ArrayBuffer

EndingType

EndingType: "transparent" | "native"

HeadersInit

HeadersInit: Headers | string[][] | Record<string, string>

RequestInfo

RequestInfo: Request | URL | string

RequestRedirect

RequestRedirect: "follow" | "manual" | "error"

Variables

console

console: Console

Const global

global: typeof globalThis

Functions

atob

  • atob(encodedString: string): string

  • Parameters

    • encodedString: string

    Returns string

btoa

  • btoa(rawString: string): string

  • Parameters

    • rawString: string

    Returns string

clearInterval

  • clearInterval(handle: number): void

  • Parameters

    • handle: number

    Returns void

clearTimeout

  • clearTimeout(handle: number): void

  • Parameters

    • handle: number

    Returns void

fetch

setInterval

  • setInterval(handler: function, timeout?: undefined | number, ...arguments: any[]): number

  • Parameters

    • handler: function
        • (...args: any[]) => void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional timeout: undefined | number
    • Rest ...arguments: any[]

    Returns number

setTimeout

  • setTimeout(handler: function, timeout?: undefined | number, ...arguments: any[]): number

  • Parameters

    • handler: function
        • (...args: any[]) => void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional timeout: undefined | number
    • Rest ...arguments: any[]

    Returns number

sleep

  • sleep(timeout: number): Promise<void>

  • Parameters

    • timeout: number

    Returns Promise<void>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc