Skip to content

Add documentation for the executeSync method #2941

Closed
Listed in
@brybrophy

Description

@brybrophy

My company recently discovered the undocumented executeSync method that is exposed in graphql-js. We would like to use it to synchronously generate schema based mock data for our tests, however, we are wary of using an undocumented API.

Is this method intended for internal use only, or is it safe to assume that no breaking changes will be introduced? If this method is safe for external users to consume, it would be great to add it to the documentation.

Activity

brybrophy

brybrophy commented on Feb 25, 2021

@brybrophy
Author

Actually, it seems that all of these exports from execution/index are undocumented. So I would like to extend my question to ask if these are all intended for external consumption.

graphql-js/src/index.js

Lines 277 to 285 in 735975d

// Execute GraphQL queries.
export {
execute,
executeSync,
defaultFieldResolver,
defaultTypeResolver,
responsePathAsArray,
getDirectiveValues,
} from './execution/index';

added a commit that references this issue on Nov 2, 2024
added a commit that references this issue on Nov 4, 2024
84a49f7
added 4 commits that reference this issue on Nov 26, 2024
31361de
24e9d11
3c0e3a2
57fa611
added 2 commits that reference this issue on Jan 14, 2025
a73060d
6211aa8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @brybrophy@saihaj

      Issue actions

        Add documentation for the executeSync method · Issue #2941 · graphql/graphql-js