Skip to content

Latest commit

 

History

History
523 lines (275 loc) · 8.49 KB

README.md

File metadata and controls

523 lines (275 loc) · 8.49 KB

@uniswap/token-lists

@types/tokenlist

Index

Interfaces

Variables

Functions

Variables

Const VersionUpgrade

VersionUpgrade: object

Defined in token.d.ts:3

Declaration file generated by dts-gen

Type declaration:

  • 0: string

  • 1: string

  • 2: string

  • 3: string

  • MAJOR: number

  • MINOR: number

  • NONE: number

  • PATCH: number


Const schema

schema: object

Defined in token.d.ts:14

Type declaration:

  • $id: string

  • $schema: string

  • additionalProperties: boolean

  • definitions(): object

    • ExtensionIdentifier(): object

      • description: string

      • examples: string[]

      • maxLength: number

      • minLength: number

      • pattern: string

      • type: string

    • ExtensionValue(): object

      • anyOf: object[]
    • TagDefinition(): object

      • additionalProperties: boolean

      • description: string

      • examples: object[]

      • properties(): object

        • description(): object

          • description: string

          • maxLength: number

          • minLength: number

          • pattern: string

          • type: string

        • name(): object

          • description: string

          • maxLength: number

          • minLength: number

          • pattern: string

          • type: string

      • required: string[]

      • type: string

    • TagIdentifier(): object

      • description: string

      • examples: string[]

      • maxLength: number

      • minLength: number

      • pattern: string

      • type: string

    • TokenInfo(): object

      • additionalProperties: boolean

      • description: string

      • properties(): object

        • address(): object

          • description: string

          • examples: string[]

          • pattern: string

          • type: string

        • chainId(): object

          • description: string

          • examples: number[]

          • minimum: number

          • type: string

        • decimals(): object

          • description: string

          • examples: number[]

          • maximum: number

          • minimum: number

          • type: string

        • extensions(): object

          • additionalProperties(): object

            • $ref: string
          • description: string

          • examples: object[]

          • maxProperties: number

          • propertyNames(): object

            • $ref: string
          • type: string

        • logoURI(): object

          • description: string

          • examples: string[]

          • format: string

          • type: string

        • name(): object

          • description: string

          • examples: string[]

          • maxLength: number

          • minLength: number

          • pattern: string

          • type: string

        • symbol(): object

          • description: string

          • examples: string[]

          • maxLength: number

          • minLength: number

          • pattern: string

          • type: string

        • tags(): object

          • description: string

          • examples: string[]

          • items(): object

            • $ref: string
          • maxLength: number

          • type: string

      • required: string[]

      • type: string

    • Version(): object

      • additionalProperties: boolean

      • description: string

      • examples: object[]

      • properties(): object

        • major(): object

          • description: string

          • examples: number[]

          • minimum: number

          • type: string

        • minor(): object

          • description: string

          • examples: number[]

          • minimum: number

          • type: string

        • patch(): object

          • description: string

          • examples: number[]

          • minimum: number

          • type: string

      • required: string[]

      • type: string

  • description: string

  • properties(): object

    • keywords(): object

      • description: string

      • items(): object

        • description: string

        • examples: string[]

        • maxLength: number

        • minLength: number

        • pattern: string

        • type: string

      • maxItems: number

      • type: string

      • uniqueItems: boolean

    • logoURI(): object

      • description: string

      • examples: string[]

      • format: string

      • type: string

    • name(): object

      • description: string

      • examples: string[]

      • maxLength: number

      • minLength: number

      • pattern: string

      • type: string

    • tags(): object

      • additionalProperties(): object

        • $ref: string
      • description: string

      • examples: object[]

      • maxProperties: number

      • propertyNames(): object

        • $ref: string
      • type: string

    • timestamp(): object

      • description: string

      • format: string

      • type: string

    • tokens(): object

      • description: string

      • items(): object

        • $ref: string
      • maxItems: number

      • minItems: number

      • type: string

    • version(): object

      • $ref: string
  • required: string[]

  • title: string

  • type: string

Functions

diffTokenLists

diffTokenLists(base: any, update: any): any

Defined in token.d.ts:244

Parameters:

Name Type
base any
update any

Returns: any


getVersionUpgrade

getVersionUpgrade(base: any, update: any): any

Defined in token.d.ts:246

Parameters:

Name Type
base any
update any

Returns: any


isVersionUpdate

isVersionUpdate(base: any, update: any): any

Defined in token.d.ts:248

Parameters:

Name Type
base any
update any

Returns: any


minVersionBump

minVersionBump(baseList: any, updatedList: any): any

Defined in token.d.ts:250

Parameters:

Name Type
baseList any
updatedList any

Returns: any


nextVersion

nextVersion(base: any, bump: any): any

Defined in token.d.ts:252

Parameters:

Name Type
base any
bump any

Returns: any


versionComparator

versionComparator(versionA: any, versionB: any): any

Defined in token.d.ts:254

Parameters:

Name Type
versionA any
versionB any

Returns: any @types/tokenlistTags

Interface: Tags

Hierarchy

  • Tags

Indexable

  • [ tagId: string]: object

  • description: string

  • name: string