nexus - npm Package Compare versions

Comparing version 0.0.0-pr.938.1.a0e81d1 to 0.0.0-pr.938.2.11866c9

dist-esm/definitions/definitionBlocks.d.ts

@@ -614,2 +614,27 @@ import type { GraphQLFieldConfig, GraphQLFieldResolver, GraphQLInputFieldConfig } from 'graphql';
     field<FieldName extends string>(name: FieldName, config: FieldOutConfig<TypeName, FieldName>): void;
+    /**
+     * [GraphQL 2018 Spec](https://spec.graphql.org/June2018/#sec-Language.Fields)
+     *
+     * Define a field on this object.
+     *
+     * A field describes one discrete piece of information available to request within a [selection
+     * set](https://spec.graphql.org/June2018/#sec-Selection-Sets). They are in fact most of what any selection
+     * set will contain. Fields can be typed as scalars (marking the terminal point of a branch of a selection
+     * set) or as other object types in your schema thus allowing you to model relationships between things.
+     *
+     * @example
+     *   objectType({
+     *     name: 'User',
+     *     definition(t) {
+     *       t.field({
+     *         name: 'id',
+     *         type: id(),
+     *         description: 'The unique identification number for this user',
+     *       })
+     *     },
+     *   })
+     *
+     * @param config The configuration for things like the field's type, its description, its arguments, its
+     *   resolver, and more. See jsdoc on each field within for details.
+     */
     field<FieldName extends string>(config: FieldOutConfigWithName<TypeName, FieldName>): void;
@@ -616,0 +641,0 @@ private _wrapClass;

dist-esm/definitions/mutationField.d.ts

@@ -110,7 +110,6 @@ import type { FieldOutConfig, OutputDefinitionBlock } from '../core';
  *
- * @param name The name of the field on the Mutation type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ * @param name The name of the field on the Mutation type. Names are case‐sensitive and must conform to
+ *   pattern: `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
  */
 export declare function mutationField<FieldName extends string>(name: FieldName, config: MutationFieldConfig<FieldName>): NexusExtendTypeDef<'Mutation'>;

dist-esm/definitions/queryField.d.ts

@@ -97,6 +97,5 @@ import type { FieldOutConfig, OutputDefinitionBlock } from '../core';
  * @param name The name of the field on the Query type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ *   `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
  */
 export declare function queryField<FieldName extends string>(name: FieldName, config: QueryFieldConfig<FieldName>): NexusExtendTypeDef<'Query'>;

dist-esm/definitions/subscriptionField.d.ts

@@ -218,6 +218,5 @@ import { NexusExtendTypeDef } from './extendType';
  * @param name The name of the field on the Query type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ *   `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
  */
 export declare function subscriptionField<FieldName extends string, Event>(name: FieldName, config: SubscriptionFieldConfig<FieldName, Event>): NexusExtendTypeDef<'Subscription'>;

dist/definitions/definitionBlocks.d.ts

@@ -614,2 +614,27 @@ import type { GraphQLFieldConfig, GraphQLFieldResolver, GraphQLInputFieldConfig } from 'graphql';
     field<FieldName extends string>(name: FieldName, config: FieldOutConfig<TypeName, FieldName>): void;
+    /**
+     * [GraphQL 2018 Spec](https://spec.graphql.org/June2018/#sec-Language.Fields)
+     *
+     * Define a field on this object.
+     *
+     * A field describes one discrete piece of information available to request within a [selection
+     * set](https://spec.graphql.org/June2018/#sec-Selection-Sets). They are in fact most of what any selection
+     * set will contain. Fields can be typed as scalars (marking the terminal point of a branch of a selection
+     * set) or as other object types in your schema thus allowing you to model relationships between things.
+     *
+     * @example
+     *   objectType({
+     *     name: 'User',
+     *     definition(t) {
+     *       t.field({
+     *         name: 'id',
+     *         type: id(),
+     *         description: 'The unique identification number for this user',
+     *       })
+     *     },
+     *   })
+     *
+     * @param config The configuration for things like the field's type, its description, its arguments, its
+     *   resolver, and more. See jsdoc on each field within for details.
+     */
     field<FieldName extends string>(config: FieldOutConfigWithName<TypeName, FieldName>): void;
@@ -616,0 +641,0 @@ private _wrapClass;

dist/definitions/mutationField.d.ts

@@ -110,7 +110,6 @@ import type { FieldOutConfig, OutputDefinitionBlock } from '../core';
  *
- * @param name The name of the field on the Mutation type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ * @param name The name of the field on the Mutation type. Names are case‐sensitive and must conform to
+ *   pattern: `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
  */
 export declare function mutationField<FieldName extends string>(name: FieldName, config: MutationFieldConfig<FieldName>): NexusExtendTypeDef<'Mutation'>;

dist/definitions/queryField.d.ts

@@ -97,6 +97,5 @@ import type { FieldOutConfig, OutputDefinitionBlock } from '../core';
  * @param name The name of the field on the Query type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ *   `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
  */
 export declare function queryField<FieldName extends string>(name: FieldName, config: QueryFieldConfig<FieldName>): NexusExtendTypeDef<'Query'>;

dist/definitions/subscriptionField.d.ts

@@ -218,6 +218,5 @@ import { NexusExtendTypeDef } from './extendType';
  * @param name The name of the field on the Query type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ *   `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
  */
 export declare function subscriptionField<FieldName extends string, Event>(name: FieldName, config: SubscriptionFieldConfig<FieldName, Event>): NexusExtendTypeDef<'Subscription'>;

package.json

 {
   "name": "nexus",
-  "version": "0.0.0-pr.938.1.a0e81d1",
+  "version": "0.0.0-pr.938.2.11866c9",
   "description": "Scalable, strongly typed GraphQL schema development",
@@ -5,0 +5,0 @@ "keywords": [

src/definitions/definitionBlocks.ts

@@ -691,2 +691,27 @@ import type { GraphQLFieldConfig, GraphQLFieldResolver, GraphQLInputFieldConfig } from 'graphql'
   field<FieldName extends string>(name: FieldName, config: FieldOutConfig<TypeName, FieldName>): void
+  /**
+   * [GraphQL 2018 Spec](https://spec.graphql.org/June2018/#sec-Language.Fields)
+   *
+   * Define a field on this object.
+   *
+   * A field describes one discrete piece of information available to request within a [selection
+   * set](https://spec.graphql.org/June2018/#sec-Selection-Sets). They are in fact most of what any selection
+   * set will contain. Fields can be typed as scalars (marking the terminal point of a branch of a selection
+   * set) or as other object types in your schema thus allowing you to model relationships between things.
+   *
+   * @example
+   *   objectType({
+   *     name: 'User',
+   *     definition(t) {
+   *       t.field({
+   *         name: 'id',
+   *         type: id(),
+   *         description: 'The unique identification number for this user',
+   *       })
+   *     },
+   *   })
+   *
+   * @param config The configuration for things like the field's type, its description, its arguments, its
+   *   resolver, and more. See jsdoc on each field within for details.
+   */
   field<FieldName extends string>(config: FieldOutConfigWithName<TypeName, FieldName>): void
@@ -693,0 +718,0 @@ field<FieldName extends string>(

src/definitions/mutationField.ts

@@ -117,5 +117,4 @@ import type { FieldOutConfig, OutputDefinitionBlock } from '../core'
  *
- * @param name The name of the field on the Mutation type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ * @param name The name of the field on the Mutation type. Names are case‐sensitive and must conform to
+ *   pattern: `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
@@ -122,0 +121,0 @@ */

src/definitions/queryField.ts

@@ -104,4 +104,3 @@ import type { FieldOutConfig, OutputDefinitionBlock } from '../core'
  * @param name The name of the field on the Query type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ *   `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
@@ -108,0 +107,0 @@ */

src/definitions/subscriptionField.ts

@@ -225,4 +225,3 @@ import { extendType, NexusExtendTypeDef } from './extendType'
  * @param name The name of the field on the Query type. Names are case‐sensitive and must conform to pattern:
- *
- *         [_A-Za-z][_0-9A-Za-z]*
+ *   `[_A-Za-z][_0-9A-Za-z]*`
  * @param config The same type of configuration you would pass to t.field("...", config)
@@ -229,0 +228,0 @@ */

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2094765

increased by0.15%

Lines of code

32661

increased by0.2%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes