Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-03 23:00:14 -05:00
Code Issues Activity

Cleaned up JSDocs referencing TestAgent

Browse source 
refs https://github.com/TryGhost/Toolbox/issues/214

- Previous docs were out of date
This commit is contained in:
Naz 2022-02-21 11:52:22 +07:00 • committed by naz
parent 027d6a84a8
commit 8c311419c6
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
test/utils/e2e-framework.js
View file

@ -143,13 +143,13 @@ const resetData = async () => {
};
/**
* Creates a TestAgent which is a drop-in substitution for supertest.
* Creates a AdminAPITestAgent which is a drop-in substitution for supertest.
* It is automatically hooked up to the Admin API so you can make requests to e.g.
* agent.get('/posts/') without having to worry about URL paths
*
* @param {Object} [options={}]
* @param {Boolean} [options.members] Include members in the boot process
* @returns {TestAgent} agent
* @returns {Promise<AdminAPITestAgent>} agent
*/
const getAdminAPIAgent = async (options = {}) => {
const bootOptions = {};
@ -173,11 +173,11 @@ const getAdminAPIAgent = async (options = {}) => {
};
/**
* Creates a TestAgent which is a drop-in substitution for supertest
* Creates a MembersAPITestAgent which is a drop-in substitution for supertest
* It is automatically hooked up to the Members API so you can make requests to e.g.
* agent.get('/webhooks/stripe/') without having to worry about URL paths
*
* @returns {Promise<TestAgent>} agent
* @returns {Promise<MembersAPITestAgent>} agent
*/
const getMembersAPIAgent = async () => {
const bootOptions = {