Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GraphQLService

Class for representing a GraphQL Service.

Hierarchy

  • TypescriptService
    • GraphQLService

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new GraphQLService(context: ExecutionContext, info: Info, schemas: Schema[]): GraphQLService

  • Constructor for the GraphQL service.

    Parameters

    • context: ExecutionContext

      Path to the service.yaml.

    • info: Info

      Info of the service.

    • schemas: Schema[]

      List of service schemas.

    Returns GraphQLService

Properties

Protected context

context: ExecutionContext

environmentManager

environmentManager: EnvironmentManager

info

info: Info

schemas

schemas: Schema[]

selectedEnvironmentName

selectedEnvironmentName: string

type

type: string

Static DIRNAME

DIRNAME: string = __dirname

Static NAME

NAME: string = "graphql"

Accessors

dependencies

devDependencies

  • Object of dev dependencies and their version.

    memberof

    GraphQLService

    function

    devDependencies

    Returns DependenciesType

    Object of package name and version.

scripts

  • get scripts(): Record<string, string>

  • Object of the scripts.

    function

    scripts

    memberof

    GraphQLService

    Returns Record<string, string>

    Object of the scripts.

serviceDirectory

  • get serviceDirectory(): string

Methods

addSchema

  • addSchema(schema: Schema): Schema

  • Parameters

    • schema: Schema

    Returns Schema

createESLintConfig

  • createESLintConfig(): void

createGitIgnore

  • createGitIgnore(): Promise<void>

createIgnoreFiles

  • createIgnoreFiles(): void

createPackageFile

  • createPackageFile(): void

  • Returns void

createREADME

  • createREADME(): void

createSourceDirectory

  • createSourceDirectory(): string

createSourceFiles

  • createSourceFiles(): void

  • Returns void

getSchema

  • getSchema(identifier: string): Schema | null

  • Parameters

    • identifier: string

    Returns Schema | null

installPackages

  • installPackages(): void

  • Returns void

makeESLintConfig

  • makeESLintConfig(): ESLintConfigType

  • Returns ESLintConfigType

makeFileHeader

  • makeFileHeader(fileName: string): string

  • Parameters

    • fileName: string

    Returns string

makeFileHeaderLines

  • makeFileHeaderLines(fileName: string): string[]

  • Parameters

    • fileName: string

    Returns string[]

makeIgnoreComponents

  • makeIgnoreComponents(): string[]

  • Returns string[]

makeMainIndexFileContent

  • makeMainIndexFileContent(): string

  • Make the main index.ts file content.

    function

    makeMainIndexFileContent

    Returns string

    index.ts file content.

makePackageContent

  • makePackageContent(): PackageJSONType

  • Returns PackageJSONType

makeREADMELines

  • makeREADMELines(): string[]

postInit

  • postInit(): void

  • Event listener for after an initialization.

    function

    postInit

    memberof

    GraphQLService

    Returns void

postVersionBump

  • postVersionBump(): void

  • Returns void

readPackageFile

  • readPackageFile(): PackageJSONType | null

  • Returns PackageJSONType | null

readTemplate

  • readTemplate(scope: string, fileName: string): string

  • Parameters

    • scope: string
    • fileName: string

    Returns string

removeSchema

  • removeSchema(identifier: string): boolean

  • Parameters

    • identifier: string

    Returns boolean

serialize

write

  • write(): boolean

  • Returns boolean

writePackageFile

  • writePackageFile(pkg: PackageJSONType): void

  • Parameters

    • pkg: PackageJSONType

    Returns void

Static deserialize

  • Deserialize an object into an GraphQLService instance.

    function

    deserialize

    static
    memberof

    GraphQLService

    Parameters

    • context: ExecutionContext

      Path to the service.yaml.

    • data: GraphQLServiceType

      Javascript object of the Info.

    Returns GraphQLService

    Service object.

Static makeInitialData

  • makeInitialData(identifier: string, user: User | null): InitializeServiceDataType

  • Parameters

    • identifier: string
    • user: User | null

    Returns InitializeServiceDataType

Static makeObject

  • Make a GraphQLService object.

    static

    Parameters

    • data: InitializeServiceDataType

      Data for the GraphQLService object.

    • user: User | null

      User instance.

    Returns GraphQLServiceType

    New GraphQLService object.

Generated using TypeDoc