Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note about passing context as a function #757

Merged
merged 5 commits into from
Jul 13, 2018

Conversation

jlengstorf
Copy link
Contributor

We realized today (by mistake) that the value of context in GraphQLOptions can be a function. Adding a note to the docs so it doesn't surprise anyone else.

We realized today (by mistake) that the value of `context` in `GraphQLOptions` can be a function. Adding a note to the docs so it doesn't surprise anyone else.
@@ -75,6 +75,8 @@ app.use(
);
```

**NOTE:** The value passed to `context` can also be a function. However, [no arguments are passed when it’s called](https://github.com/apollographql/apollo-server/blob/df51fd90dad90c9468a74e2c4ec2a6af69f4188d/packages/apollo-server-core/src/runHttpQuery.ts#L138-L139), so there’s not really any reason to do so.
Copy link
Contributor

@n1ru4l n1ru4l Jan 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is actually a reason for this: Constructing a new context based on the current request.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly like in this scenario #420 (comment)

jlengstorf and others added 3 commits January 14, 2018 09:20
- fix description per @n1ru4l's feedback
- add a code example of instantiating a new class in the context for each request
@abernix abernix added the 📝 documentation Focuses on changes to the documentation (docs) label Apr 18, 2018
@evans evans merged commit bf06caf into apollographql:master Jul 13, 2018
@evans
Copy link
Contributor

evans commented Jul 13, 2018

Thank you! Merged before moving to the V2 docs

@jlengstorf jlengstorf deleted the patch-1 branch July 13, 2018 19:53
evans pushed a commit that referenced this pull request Jul 13, 2018
* chore(deps): update dependency @adonisjs/bodyparser to v2.0.3

* docs: Fix typo in lambda package README (#999)

* chore(deps): update dependency @types/aws-lambda to v8.10.3

* chore(deps): update dependency @types/node to v9.6.7

* chore(deps): update dependency koa to v2.5.1

* chore(deps): update dependency hapi to v17.4.0 (#1009)

* chore(deps): update dependency sinon to v5 (#1010)

* chore(deps): update dependency @types/node to v9.6.8

* chore(deps): update dependency sinon to v5.0.2

* Temporarily remove version 2.

* Update meteor-theme-hexo to 1.0.9.

* chore(deps): update dependency sinon to v5.0.3

* chore(deps): update dependency @types/node to v9.6.9

* Revert "Temporarily remove version 2."

This reverts commit 6f50769.

* Update package.json's hexo.version to 3.7.1.

* chore(deps): update dependency @types/node to v9.6.11

* chore(deps): update dependency @types/node to v9.6.12

* chore(deps): update dependency hexo-server to v0.3.2

* chore(deps): update dependency sinon to v5.0.5

* chore(deps): update dependency sinon to v5.0.6

* chore(deps): update dependency sinon to v5.0.7

* chore(deps): update dependency @types/node to v9.6.14

* chore(deps): update dependency @types/sinon to v4.3.2

* bump version of subscriptions-transport-ws for graphiql

The newer subscription client has a more forgiving default ka timeout

* chore(deps): update dependency @types/node to v9.6.15

* chore(deps): update dependency @types/sinon to v4.3.3

* Fix typos in setup.md

* fix graphiql docs for hapi

* tests: Stop testing Node.js 4, which has reached the end of its LTS. (#1026)

Node.js 4 will no longer be receiving any additional updates from the
Node.js foundation, as per the expected LTS schedule[0] and their blog post:

https://medium.com/the-node-js-collection/april-2018-release-updates-from-the-node-js-project-71687e1f7742

[0]: https://github.com/nodejs/LTS

* chore(deps): update dependency @types/node to v9.6.18

* chore(deps): update dependency @types/aws-lambda to v8.10.4

* chore(deps): update dependency @types/restify to v5.0.8

* chore(deps): update dependency body-parser to v1.18.3

* chore(deps): update dependency koa-bodyparser to v4.2.1

* chore(deps): update dependency mocha to v5.2.0

* chore(deps): update dependency supertest to v3.1.0

* chore(deps): update dependency hapi to v17.5.0

* docs: add pointer to apollo server 2 documentation (#1083)

* chore(deps): update dependency meteor-theme-hexo to v1.0.10

* chore(deps): update dependency @types/aws-lambda to v8.10.5

* chore(deps): update dependency sinon to v5.0.9

* chore(deps): update dependency sinon to v5.0.10

* chore(deps): update dependency @types/node to v9.6.19

* chore(deps): update dependency hapi to v17.5.1

* chore(deps): update dependency typescript to v2.8.4

* chore(deps): update dependency meteor-theme-hexo to v1.0.13 (#1118)

* chore(deps): update dependency @types/aws-lambda to v8.10.6

* chore(deps): update dependency @types/node to v9.6.20

* koa: remove dist names from readme example (#1122)

Since koa@2 has been published for a long time, and almost all the middlewares migrated to koa@2.
It's no need to add extra dist names for koa and koa middlewares.

* chore(deps): update dependency @types/koa to v2.0.46

* chore(deps): update dependency @types/mocha to v5.2.1

* chore(deps): update dependency @types/restify to v5.0.9

* chore(deps): update dependency @types/express to v4.16.0

* chore(deps): update dependency sinon to v5.1.0

* chore(deps): update dependency @types/node to v9.6.21

* chore(deps): update dependency sinon to v5.1.1

* docs: Add/update documentation README.md.

In order to provide a more universal README.md across all documentation
deployment repositories, and most importantly, to reference the so-called
"documentation for the documentation".

* chore(deps): update dependency meteor-theme-hexo to v1.0.14 (#1199)

This Pull Request updates dependency [meteor-theme-hexo](https://github.com/meteor/meteor-theme-hexo) from `v1.0.13` to `v1.0.14`

**Note**: This PR was created on a configured schedule ("after 10pm every weekday,before 5am every weekday" in timezone `America/Los_Angeles`) and will not receive updates outside those times.


<details>
<summary>Release Notes</summary>

### [`v1.0.14`](https://github.com/meteor/meteor-theme-hexo/blob/master/CHANGELOG.md#v1014)
[Compare Source](meteor/meteor-theme-hexo@v1.0.13...v1.0.14)
* Allow the "Edit on GitHub" button to work on "versioned" documentation.
  [PR #&#8203;80](`meteor/meteor-theme-hexo#80)

---

</details>




---

This PR has been generated by [Renovate Bot](https://renovatebot.com).

* Update renovate.json

* Update renovate.json

Hopefully these additional hours and the offset won't be problematic for anyone, but they should help me out some.

We'll see!

* Update renovate.json

* chore(deps): pin dependency hexo-versioned-netlify-redirects to v1.0.7 (#1203)

This Pull Request updates dependency `hexo-versioned-netlify-redirects` from `^1.0.7` to `v1.0.7`



---

This PR has been generated by [Renovate Bot](https://renovatebot.com).

* chore(deps): update dependency @types/chai to v4.1.4

* chore(deps): update dependency @types/koa-router to v7.0.29

* chore(deps): update dependency @types/mocha to v5.2.3

* chore(deps): update dependency @types/multer to v1.3.7

* chore(deps): update dependency @types/node to v9.6.22

* chore(deps): update dependency meteor-theme-hexo to v1.0.15

* chore(deps): update dependency @types/koa-router to v7.0.30

* chore(deps): update dependency @types/aws-lambda to v8.10.7

* chore(deps): update dependency hapi to v17.5.2

* Use apollo-server v1 in example relating to v1

* docs: Add sentence punctuation to 2.0 callout.

Follows-up on #1083.

* chore(deps): update dependency meteor-theme-hexo to v1.0.16 (#1262)

This Pull Request updates dependency [meteor-theme-hexo](https://github.com/meteor/meteor-theme-hexo) from `v1.0.15` to `v1.0.16`



<details>
<summary>Release Notes</summary>

### [`v1.0.16`](https://github.com/meteor/meteor-theme-hexo/blob/master/CHANGELOG.md#v1016)
[Compare Source](meteor/meteor-theme-hexo@v1.0.15...v1.0.16)
* Re-introduce the scrolling ability within search results.
  [PR #&#8203;83](`meteor/meteor-theme-hexo#83)

---

</details>




---

This PR has been generated by [Renovate Bot](https://renovatebot.com).

* chore(deps): update dependency @types/mocha to v5.2.4

* chore(deps): update dependency multer to v1.3.1

* chore(deps): update dependency @types/node to v9.6.23

* chore(deps): update dependency apollo-hexo-config to v1.0.8 (#1329)

This Pull Request updates dependency [apollo-hexo-config](https://github.com/apollographql/apollo-hexo-config) from `v1.0.7` to `v1.0.8`



<details>
<summary>Release Notes</summary>

### [`v1.0.8`](https://github.com/apollographql/apollo-hexo-config/compare/v1.0.7...v1.0.8)
[Compare Source](https://github.com/apollographql/apollo-hexo-config/compare/v1.0.7...v1.0.8)


---

</details>




---

This PR has been generated by [Renovate Bot](https://renovatebot.com).

* docs: Add browser auto-reloading on source content changes. (#1336)

By virtue of a relatively simple `hexo-browsersync` package[0], which
implements BrowserSync[1] in Hexo, this change brings support for automatically
reloading the browser when the source content has changed.

No more pressing "Reload" in order to see the changes to the Markdown source
when working on documentation! 🎉

[0]: https://npm.im/hexo-browsersync
[1]: https://www.browsersync.io

* chore(deps): update dependency koa to v2.5.2

* docs: add note about passing context as a function (#757)

* docs: add note about passing context as a function

We realized today (by mistake) that the value of `context` in `GraphQLOptions` can be a function. Adding a note to the docs so it doesn't surprise anyone else.

* docs: update context as a function docs

- fix description per @n1ru4l's feedback
- add a code example of instantiating a new class in the context for each request

* Added option to disable rewriting URL for GraphiQL (#1047)

* added option to disable rewriting url for graphiql

* updated docs

* added link to PR in changelog

* Add skipValidation option. (#839)

* Don't validate if query is already an AST.

* Skip validation option.

* fix(hapi16_support): add hapi 16 next() invocation [closes #744] (#743)

* chore(hapi16_support): add hapi 16 next() invocation

* run lint fix

* update changelog

* feat(fastify): Integrate apollo-fastify plugin (#1013)

* Integrate apollo-fastify plugin #626

* #626 Fix typescript issues

* #626 Update changelog

* #626 Update README

* #626 Fix the breaking tests

* #626 Fix code review comments

* #626 Run Hapi tests only for node 8 and 9

* #626 Run Hapi tests only for node 8 and 9

* #626 Commit package.lock in working state

* #626 Use npm instead of yarn for node 4

* Revert package-lock and circle ci test job steps

* #626 Bump the version

* v1.4.0

* bring version-2 up to date

* remove apollo-server-fastify

* fix export of hapi middleware

* remove setup

* fix hapi readme

* remove unused tests
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📝 documentation Focuses on changes to the documentation (docs)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants