Options
All
  • Public
  • Public/Protected
  • All
Menu

Module functions/setup

Index

Functions

Functions

persistCrawlSetup

  • persistCrawlSetup(crawlSetup: any[], oraOutput: any): Promise<DataResponse>

  • Persist the initialized crawlers via a loop and create appropriate crawler configurations. Save these configurations as defaults.

    Parameters

    • crawlSetup: any[]

      array of inquirer response objects containing responses from promptCrawlSetup

    • oraOutput: any

      ora variable to update with appropriate status message

    Returns Promise<DataResponse>

    Success or Failure Data Response

persistIdentitySetup

  • Following the setup process of an Identity, create or import the identity, then save as default

    Parameters

    • idSetup: any

      inquirer response object containing responses from promptIdentitySetup

    • oraOutput: any

      ora variable to update with appropriate status message

    Returns Promise<IdentityResponse>

    identity response with full identity if successful

persistNetworkSetup

  • persistNetworkSetup(netSetup: any, oraOutput: any, force?: boolean): Promise<DataResponse>

  • Persist the network setup data as default and add it to psqr.

    Parameters

    • netSetup: any

      inquirer response object containing responses from promptNetworkSetup

    • oraOutput: any

      ora variable to update with appropriate status message

    • force: boolean = false

      skip any confirmation and ora output and just persist

    Returns Promise<DataResponse>

    data response describing success

persistProxySetup

  • Persist the Proxy Initialization Data as environment variables

    Parameters

    • proxySetup: any

      inquirer response object containing responses from promptProxySetup

    Returns Promise<DataResponse>

    data response describing success

promptCrawlSetup

  • promptCrawlSetup(identity: { did: string; didDoc: { "@context": ("https://www.w3.org/ns/did/v1" | "https://vpsqr.com/ns/did-psqr/v1")[]; id: string; psqr: { publicIdentity: { name: string; description?: string | undefined; image?: string | undefined; url?: string | undefined; tagline?: string | undefined; bio?: string | undefined; }; publicKeys: { ...; }[]; permiss...; keyPairs: { kid: string; private: { x: string; y: string; crv: "P-384"; alg: "ES384"; kty: "EC"; kid: string; } & { d: string; }; public?: { x: string; y: string; crv: "P-384"; alg: "ES384"; kty: "EC"; kid: string; } | undefined; }[] }): Promise<any[]>

  • Prompt the user for infomation on crawlers that they want to add. This function will prompt for additional crawler creations.

    Parameters

    • identity: { did: string; didDoc: { "@context": ("https://www.w3.org/ns/did/v1" | "https://vpsqr.com/ns/did-psqr/v1")[]; id: string; psqr: { publicIdentity: { name: string; description?: string | undefined; image?: string | undefined; url?: string | undefined; tagline?: string | undefined; bio?: string | undefined; }; publicKeys: { ...; }[]; permiss...; keyPairs: { kid: string; private: { x: string; y: string; crv: "P-384"; alg: "ES384"; kty: "EC"; kid: string; } & { d: string; }; public?: { x: string; y: string; crv: "P-384"; alg: "ES384"; kty: "EC"; kid: string; } | undefined; }[] }

      identity object that was generated earlier by the user

      • did: string
      • didDoc: { "@context": ("https://www.w3.org/ns/did/v1" | "https://vpsqr.com/ns/did-psqr/v1")[]; id: string; psqr: { publicIdentity: { name: string; description?: string | undefined; image?: string | undefined; url?: string | undefined; tagline?: string | undefined; bio?: string | undefined; }; publicKeys: { ...; }[]; permiss...
      • keyPairs: { kid: string; private: { x: string; y: string; crv: "P-384"; alg: "ES384"; kty: "EC"; kid: string; } & { d: string; }; public?: { x: string; y: string; crv: "P-384"; alg: "ES384"; kty: "EC"; kid: string; } | undefined; }[]

    Returns Promise<any[]>

    crawlSetup response array with info for all requested crawls

promptIdentitySetup

  • Prompt the user for desired Identity setup

    Returns Promise<DataResponse>

    idSetup data reponse object with combined responses

promptNetworkSetup

  • promptNetworkSetup(): Promise<any>

  • Prompt the user for network setup information

    Returns Promise<any>

    netSetup response object with combined responses

promptProxySetup

  • promptProxySetup(): Promise<any>

  • Prompt the user for Proxy Setup Information

    Returns Promise<any>

    proxySetup response object with combined responses