@servicenow/sdk - v4.13.3
    Preparing search index...
    Index

    Constructors

    • Parameters

      Returns ProjectFactory

    Methods

    • Parameters

      • workingDir: string
      • connector: IConnector
      • scopeOptions: { scope: string | undefined; scopeId: string | undefined }
      • options: Partial<Pick<InitOptions, "sdkVersion" | "packageName">>

      Returns Promise<Project>

    • Parameters

      Returns Promise<Project>

    • Parameters

      Returns Promise<Project>

    • Parameters

      • workingDir: string
      • metadataDir: string
      • options: Partial<Pick<InitOptions, "sdkVersion" | "packageName" | "conversion">>

      Returns Promise<Project>

    • Returns (TemplateInfo & { id: keyof Templates })[]

    • Parameters

      • workingDir: string

      Returns Record<string, string>

    • Resolves the parameter declarations to prompt for before a template is scaffolded.

      A template package owns its own declarations via .template.json at the root of its templatePath; when it ships one, its params replace the SDK's baked copy wholesale rather than merging with them, so a param the template has removed stops being prompted for.

      This is also where the package is downloaded, into the factory's temp file cache, so that createProject extracts the same bytes these params were read from rather than resolving latest a second time.

      Parameters

      Returns Promise<Record<string, TemplateParam>>

    • Returns Promise<void>

    • Parameters

      • appName: string

      Returns string