Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Manik2708 committed Jan 28, 2024
1 parent 0075fca commit 15e8e28
Show file tree
Hide file tree
Showing 347 changed files with 1,589 additions and 1,044 deletions.
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
"@types/lodash": "^4.14.202",
"@types/mongoose-paginate-v2": "^1.6.5",
"@types/morgan": "^1.9.9",
"@types/node": "^20.11.8",
"@types/node": "^20.11.9",
"@types/nodemailer": "^6.4.14",
"@types/shortid": "^0.0.32",
"@types/uuid": "^9.0.7",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Error.constructor

#### Defined in

[src/libraries/errors/applicationError.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L14)
[src/libraries/errors/applicationError.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L14)

## Properties

Expand All @@ -82,7 +82,7 @@ Error.constructor

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -92,7 +92,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This class detects conflict errors and sends those errors to the superclass Appl

#### Defined in

[src/libraries/errors/conflictError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/conflictError.ts#L6)
[src/libraries/errors/conflictError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/conflictError.ts#L6)

## Properties

Expand All @@ -71,7 +71,7 @@ This class detects conflict errors and sends those errors to the superclass Appl

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This class detects input validation errors and sends those errors to the supercl

#### Defined in

[src/libraries/errors/inputValidationError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/inputValidationError.ts#L6)
[src/libraries/errors/inputValidationError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/inputValidationError.ts#L6)

## Properties

Expand All @@ -71,7 +71,7 @@ This class detects input validation errors and sends those errors to the supercl

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This class detects internal server errors and sends those errors to the supercla

#### Defined in

[src/libraries/errors/internalServerError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/internalServerError.ts#L6)
[src/libraries/errors/internalServerError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/internalServerError.ts#L6)

## Properties

Expand All @@ -71,7 +71,7 @@ This class detects internal server errors and sends those errors to the supercla

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This class detects invalid file type errors and sends those errors to the superc

#### Defined in

[src/libraries/errors/invalidFileTypeError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/invalidFileTypeError.ts#L6)
[src/libraries/errors/invalidFileTypeError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/invalidFileTypeError.ts#L6)

## Properties

Expand All @@ -71,7 +71,7 @@ This class detects invalid file type errors and sends those errors to the superc

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This class detects Not Found errors and sends those errors to the superclass App

#### Defined in

[src/libraries/errors/notFoundError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/notFoundError.ts#L6)
[src/libraries/errors/notFoundError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/notFoundError.ts#L6)

## Properties

Expand All @@ -71,7 +71,7 @@ This class detects Not Found errors and sends those errors to the superclass App

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This class detects unauthenticated errors and sends those errors to the supercla

#### Defined in

[src/libraries/errors/unauthenticatedError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/unauthenticatedError.ts#L6)
[src/libraries/errors/unauthenticatedError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/unauthenticatedError.ts#L6)

## Properties

Expand All @@ -71,7 +71,7 @@ This class detects unauthenticated errors and sends those errors to the supercla

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This class detects unauthorized errors and sends those errors to the superclass

#### Defined in

[src/libraries/errors/unauthorizedError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/unauthorizedError.ts#L6)
[src/libraries/errors/unauthorizedError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/unauthorizedError.ts#L6)

## Properties

Expand All @@ -71,7 +71,7 @@ This class detects unauthorized errors and sends those errors to the superclass

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ This class detects validation errors and sends those errors to the superclass Ap

#### Defined in

[src/libraries/errors/validationError.ts:7](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/validationError.ts#L7)
[src/libraries/errors/validationError.ts:7](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/validationError.ts#L7)

## Properties

Expand All @@ -69,7 +69,7 @@ This class detects validation errors and sends those errors to the superclass Ap

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L11)

___

Expand All @@ -83,7 +83,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
6 changes: 3 additions & 3 deletions talawa-api-docs/enums/constants.TransactionLogTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#### Defined in

[src/constants.ts:497](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/constants.ts#L497)
[src/constants.ts:497](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/constants.ts#L497)

___

Expand All @@ -30,7 +30,7 @@ ___

#### Defined in

[src/constants.ts:499](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/constants.ts#L499)
[src/constants.ts:499](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/constants.ts#L499)

___

Expand All @@ -40,4 +40,4 @@ ___

#### Defined in

[src/constants.ts:498](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/constants.ts#L498)
[src/constants.ts:498](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/constants.ts#L498)
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ ___

#### Defined in

[src/libraries/dbLogger.ts:33](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/dbLogger.ts#L33)
[src/libraries/dbLogger.ts:33](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/dbLogger.ts#L33)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ ___

#### Defined in

[src/libraries/dbLogger.ts:37](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/dbLogger.ts#L37)
[src/libraries/dbLogger.ts:37](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/dbLogger.ts#L37)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

#### Defined in

[src/libraries/errors/applicationError.ts:3](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L3)
[src/libraries/errors/applicationError.ts:3](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L3)

___

Expand All @@ -31,7 +31,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:2](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L2)
[src/libraries/errors/applicationError.ts:2](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L2)

___

Expand All @@ -41,7 +41,7 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:5](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L5)
[src/libraries/errors/applicationError.ts:5](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L5)

___

Expand All @@ -51,4 +51,4 @@ ___

#### Defined in

[src/libraries/errors/applicationError.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/libraries/errors/applicationError.ts#L4)
[src/libraries/errors/applicationError.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/libraries/errors/applicationError.ts#L4)
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#### Defined in

[src/middleware/isAuth.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/middleware/isAuth.ts#L9)
[src/middleware/isAuth.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/middleware/isAuth.ts#L9)

___

Expand All @@ -30,7 +30,7 @@ ___

#### Defined in

[src/middleware/isAuth.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/middleware/isAuth.ts#L8)
[src/middleware/isAuth.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/middleware/isAuth.ts#L8)

___

Expand All @@ -40,4 +40,4 @@ ___

#### Defined in

[src/middleware/isAuth.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/ac416c4/src/middleware/isAuth.ts#L10)
[src/middleware/isAuth.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/0075fca/src/middleware/isAuth.ts#L10)
Loading

0 comments on commit 15e8e28

Please sign in to comment.