https://github.com/convoyinc/graphql-client-benchmarks

https://github.com/convoyinc/graphql-client-benchmarks

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/convoyinc/graphql-client-benchmarks
• Owner: convoyinc
• License: other
• Created: 2018-06-26T16:33:59.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-23T14:27:08.000Z (10 months ago)
• Last Synced: 2024-07-07T09:23:27.891Z (3 months ago)
• Language: TypeScript
• Homepage: https://convoyinc.github.io/graphql-client-benchmarks
• Size: 2.31 MB
• Stars: 29
• Watchers: 120
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-list - graphql-client-benchmarks

README

        
# GraphQL Client Benchmarks

A benchmarking suite for GraphQL clients, with focus on their cache implementations.

If you'd like to run them in a browser, there is a built copy hosted at: https://convoyinc.github.io/graphql-client-benchmarks/

If you want to run them in node, it is also available as a node module that exposes a bin script that executes the CLI runner.

```

npm install -g graphql-client-benchmarks

graphql-client-benchmarks

```

## Contributing & Advanced Use

For any other case, you'll want to check out the repository, or depend on the package directly.

These approaches are mostly undocumented and lightly supported—expect to roll up your sleeves!

## Examples

The benchmarking suite is set up to support many example queries and responses. If you have some you'd like to add to the suite, you can add them to the [`examples`](./examples) folder, following the same structure. They'll automatically be pulled into the benchmarking suite.

## Environments

The benchmarks are designed to be run in three different ways:

**web**: The [web reporter](./src/reporters/web) provides a UI for running the baked in examples, as well as an editor to enter your own. It can be run locally via `yarn dev` or `yarn compile`.

**cli**: The [CLI reporter](./src/reporters/cli) provides a UI for running the baked in examples on a terminal. It can be

**api**: The benchmark suite and runner is also exposed via [an API](./src/index.ts) that you can use to run the examples, or provide your own. The primary entry point is [`runSuite`](./src/execution.ts). Take a look at the web or cli reporters for an idea of how to run it, and you'll probably want to leverage the [console reporter](./src/reporters/console) to get started.