Options
All
  • Public
  • Public/Protected
  • All
Menu

All of the potential shapes for a DappItem at different points throughout our system, along with factory functions and type guards.

Index

Interfaces

Api

Api:

Dapp representation returned from private reads and lists, includes everything from full plus some dapp management data.

Abi

Abi: string

ContractAddr

ContractAddr: string

CreationTime

CreationTime: string

DappName

DappName: string

DnsName

DnsName: string

GuardianURL

GuardianURL: string

OwnerEmail

OwnerEmail: string

State

State: States

Optional TargetRepoName

TargetRepoName: undefined | string

Optional TargetRepoOwner

TargetRepoOwner: undefined | string

Tier

Tier: Tiers

Web3URL

Web3URL: string

Core

Core:

All data required to render a dapp on DappHub; this is the dapp's shape when returned from the public view.

Abi

Abi: string

ContractAddr

ContractAddr: string

DappName

DappName: string

GuardianURL

GuardianURL: string

Web3URL

Web3URL: string

Full

Full:

Core data plus the dapp's tier and some optional info about the GitHub integration. This type applies to both enterprise and standard dapps.

Abi

Abi: string

ContractAddr

ContractAddr: string

DappName

DappName: string

GuardianURL

GuardianURL: string

Optional TargetRepoName

TargetRepoName: undefined | string

Optional TargetRepoOwner

TargetRepoOwner: undefined | string

Tier

Tier: Tiers

Web3URL

Web3URL: string

FullEnterprise

FullEnterprise:

Abi

Abi: string

ContractAddr

ContractAddr: string

DappName

DappName: string

GuardianURL

GuardianURL: string

TargetRepoName

TargetRepoName: string

TargetRepoOwner

TargetRepoOwner: string

Tier

Tier: Extract<Tiers, Enterprise>

Web3URL

Web3URL: string

FullHub

FullHub:

Abi

Abi: string

ContractAddr

ContractAddr: string

DappName

DappName: string

GuardianURL

GuardianURL: string

Optional TargetRepoName

TargetRepoName: undefined | string

Optional TargetRepoOwner

TargetRepoOwner: undefined | string

Tier

Tier: Exclude<Tiers, Enterprise>

Web3URL

Web3URL: string

Functions

isApi

  • isApi(val: any): boolean
  • Type guard; returns true if the argument satisfies Item.Api, otherwise false.

    Parameters

    • val: any

    Returns boolean

isCore

  • isCore(val: any): boolean
  • Type guard; returns true if the argument satisfies Item.Core, otherwise false.

    Parameters

    • val: any

    Returns boolean

isFull

  • isFull(val: any): boolean
  • Type guard; returns true if the argument satisfies Item.Full, otherwise false.

    Parameters

    • val: any

    Returns boolean

isFullEnterprise

  • isFullEnterprise(val: any): boolean

isFullHub

  • isFullHub(val: any): boolean

newApi

  • newApi(): Api
  • Factory to produce an empty Item.Api. Useful to get the interface's keys as a value. Note that the actual values on this object are not valid.

    Returns Api

newCore

  • Factory to produce an empty Item.Core. Useful to get the interface's keys as a value. Note that the actual values on this object are not valid.

    Returns Core

newFull

  • Factory to produce an empty Item.Full. Useful to get the interface's keys as a value. Note that the actual values on this object are not valid. It produces a standard dapp, so no GitHub config.

    Returns Full

newFullEnterprise

newFullHub

Generated using TypeDoc