ScalarTypeComposer · graphql-compose

ScalarTypeComposer is a class which helps to create and modify GraphQLScalarType.

Static methods

static create<TCtx = any>(
  typeDef: ScalarTypeComposerDefinition,
  schemaComposer: SchemaComposer<TCtx>
): ScalarTypeComposer<TCtx>

Create ScalarTypeComposer with adding it by name to the SchemaComposer. This type became avaliable in SDL by its name.

static createTemp<TCtx = any>(
  typeDef: ScalarTypeComposerDefinition,
  schemaComposer: SchemaComposer<TCtx>
): ScalarTypeComposer<TCtx>

Create ScalarTypeComposer without adding it to the SchemaComposer. This method may be usefull in plugins, when you need to create type temporary.

schemaComposer: SchemaComposer<TContext>;

setSerialize(
  fn: GraphQLScalarSerializer<any>
): void

getSerialize(): GraphQLScalarSerializer<any>

setParseValue(
  fn: GraphQLScalarValueParser<any> | void
): void

getParseValue(): GraphQLScalarValueParser<any>

setParseLiteral(
  fn: GraphQLScalarLiteralParser<any> | void
): void

getParseLiteral(): GraphQLScalarLiteralParser<any>

getType(): GraphQLScalarType

getTypePlural(): ListComposer<ScalarTypeComposer<TContext>>

getTypeNonNull(): NonNullComposer<ScalarTypeComposer<TContext>>

getTypeName(): string

setTypeName(
  name: string
): this

getDescription(): string

setDescription(
  description: string
): this

clone(
  newTypeNameOrTC: string | ScalarTypeComposer<any>
): ScalarTypeComposer<TContext>

You may clone this type with a new provided name as string. Or you may provide a new TypeComposer which will get all clonned settings from this type.

merge(
  type: GraphQLScalarType | ScalarTypeComposer<any>
): this

getExtensions(): Extensions

setExtensions(
  extensions: Extensions
): this

extendExtensions(
  extensions: Extensions
): this

clearExtensions(): this

getExtension(
  extensionName: string
): any

hasExtension(
  extensionName: string
): boolean

setExtension(
  extensionName: string,
  value: any
): this

removeExtension(
  extensionName: string
): this

getDirectives(): ExtensionsDirective[]

getDirectiveNames(): string[]

getDirectiveByName(
  directiveName: string
): DirectiveArgs | void

getDirectiveById(
  idx: number
): DirectiveArgs | void

export type ScalarTypeComposerDefinition =
  | TypeAsString
  | Readonly<ScalarTypeComposerAsObjectDefinition>
  | Readonly<GraphQLScalarType>;

export type ScalarTypeComposerAsObjectDefinition = GraphQLScalarTypeConfig<any, any> & {
  extensions?: Extensions;
};