Docs
API
Modules
cli_src

Table of contents

Interfaces

Variables

Functions

Variables

DEFAULT_CLI_PARAMS

Const DEFAULT_CLI_PARAMS: GraphQLMeshCLIParams

Defined in

packages/cli/src/index.ts:44

Functions

findAndParseConfig

findAndParseConfig(options?): Promise<ProcessedConfig>

Parameters

NameType
options?ConfigProcessOptions

Returns

Promise<ProcessedConfig>


generateTsArtifacts

generateTsArtifacts(__namedParameters, cliParams): Promise<void>

Parameters

NameType
__namedParametersObject
__namedParameters.baseDirstring
__namedParameters.codegenConfigany
__namedParameters.documentsSource[]
__namedParameters.fileType"json" | "js" | "ts"
__namedParameters.flattenTypesboolean
__namedParameters.importedModulesSetSet<string>
__namedParameters.loggerLogger
__namedParameters.mergerTypestring
__namedParameters.meshConfigCodestring
__namedParameters.rawSourcesreadonly RawSourceOutput[]
__namedParameters.sdkConfigSDKConfig
__namedParameters.unifiedSchemaGraphQLSchema
cliParamsGraphQLMeshCLIParams

Returns

Promise<void>


graphqlMesh

graphqlMesh(cliParams?, args?, cwdPath?): Promise<{ $0: string ; _: (string | number)[] ; source: string } | { $0: string ; _: (string | number)[] ; source: string }>

Parameters

NameTypeDefault value
cliParamsGraphQLMeshCLIParamsDEFAULT_CLI_PARAMS
argsstring[]undefined
cwdPathstringundefined

Returns

Promise<{ $0: string ; _: (string | number)[] ; source: string } | { $0: string ; _: (string | number)[] ; source: string }>


serveMesh

serveMesh(__namedParameters, cliParams): Promise<{ app: Express ; httpServer: Server ; logger: Logger ; mesh: MeshInstance ; readyFlag: boolean }>

Parameters

NameType
__namedParametersServeMeshOptions
cliParamsGraphQLMeshCLIParams

Returns

Promise<{ app: Express ; httpServer: Server ; logger: Logger ; mesh: MeshInstance ; readyFlag: boolean }>