nexus/dist/definitions/scalarType.d.ts

Scalable, strongly typed GraphQL schema development

import { GraphQLNamedType, GraphQLScalarTypeConfig } from 'graphql';
import type { AllNexusInputTypeDefs, AllNexusOutputTypeDefs } from '../core';
import { GraphQLNamedOutputType, Maybe, SourceTypingDef } from './_types';
export interface ScalarBase extends Pick<GraphQLScalarTypeConfig<any, any>, 'description' | 'serialize' | 'parseValue' | 'parseLiteral'> {
}
export interface ScalarConfig {
    /** Any deprecation info for this scalar type */
    deprecation?: Maybe<string>;
    /** Adds this type as a method on the Object/Interface definition blocks */
    asNexusMethod?: string;
    /** Source type information for this type */
    sourceType?: SourceTypingDef;
    /**
     * Custom extensions, as supported in graphql-js
     *
     * @see https://github.com/graphql/graphql-js/issues/1527
     */
    extensions?: GraphQLScalarTypeConfig<any, any>['extensions'];
}
export interface NexusScalarTypeConfig<T extends string> extends ScalarBase, ScalarConfig {
    /** The name of the scalar type */
    name: T;
}
export declare class NexusScalarTypeDef<TypeName extends string> {
    readonly name: TypeName;
    protected config: NexusScalarTypeConfig<string>;
    constructor(name: TypeName, config: NexusScalarTypeConfig<string>);
    get value(): NexusScalarTypeConfig<string>;
}
export declare function scalarType<TypeName extends string>(options: NexusScalarTypeConfig<TypeName>): NexusScalarTypeDef<TypeName>;
export declare function asNexusMethod<T extends GraphQLNamedType>(namedType: T, methodName: string, sourceType?: SourceTypingDef): T extends GraphQLNamedOutputType ? AllNexusOutputTypeDefs : AllNexusInputTypeDefs;