Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
palisadoes committed Feb 3, 2024
1 parent 4e2c75b commit 5054743
Show file tree
Hide file tree
Showing 379 changed files with 1,906 additions and 2,362 deletions.
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/ImageSizeLimitExceeded.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/b1dd6c9/src/libraries/errors/ImageSizeLimitExceeded.ts#L6)
[src/libraries/errors/ImageSizeLimitExceeded.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/libraries/errors/ImageSizeLimitExceeded.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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/libraries/errors/applicationError.ts#L12)

___

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Error.constructor

#### Defined in

[src/libraries/errors/applicationError.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/b1dd6c9/src/libraries/errors/applicationError.ts#L14)
[src/libraries/errors/applicationError.ts:14](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/libraries/errors/applicationError.ts#L14)

## Properties

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

#### Defined in

[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/libraries/errors/applicationError.ts#L11)

___

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

#### Defined in

[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/conflictError.ts#L6)
[src/libraries/errors/conflictError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/inputValidationError.ts#L6)
[src/libraries/errors/inputValidationError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/internalServerError.ts#L6)
[src/libraries/errors/internalServerError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/invalidFileTypeError.ts#L6)
[src/libraries/errors/invalidFileTypeError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/notFoundError.ts#L6)
[src/libraries/errors/notFoundError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/unauthenticatedError.ts#L6)
[src/libraries/errors/unauthenticatedError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/unauthorizedError.ts#L6)
[src/libraries/errors/unauthorizedError.ts:6](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/validationError.ts#L7)
[src/libraries/errors/validationError.ts:7](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L11)
[src/libraries/errors/applicationError.ts:11](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L12)
[src/libraries/errors/applicationError.ts:12](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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:540](https://github.com/PalisadoesFoundation/talawa-api/blob/b1dd6c9/src/constants.ts#L540)
[src/constants.ts:528](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/constants.ts#L528)

___

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

#### Defined in

[src/constants.ts:542](https://github.com/PalisadoesFoundation/talawa-api/blob/b1dd6c9/src/constants.ts#L542)
[src/constants.ts:530](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/constants.ts#L530)

___

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

#### Defined in

[src/constants.ts:541](https://github.com/PalisadoesFoundation/talawa-api/blob/b1dd6c9/src/constants.ts#L541)
[src/constants.ts:529](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/constants.ts#L529)
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/b1dd6c9/src/libraries/dbLogger.ts#L33)
[src/libraries/dbLogger.ts:33](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/dbLogger.ts#L37)
[src/libraries/dbLogger.ts:37](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L3)
[src/libraries/errors/applicationError.ts:3](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L2)
[src/libraries/errors/applicationError.ts:2](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L5)
[src/libraries/errors/applicationError.ts:5](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/libraries/errors/applicationError.ts#L4)
[src/libraries/errors/applicationError.ts:4](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/middleware/isAuth.ts#L9)
[src/middleware/isAuth.ts:9](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/middleware/isAuth.ts#L8)
[src/middleware/isAuth.ts:8](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/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/b1dd6c9/src/middleware/isAuth.ts#L10)
[src/middleware/isAuth.ts:10](https://github.com/PalisadoesFoundation/talawa-api/blob/4e2c75b/src/middleware/isAuth.ts#L10)
Loading

0 comments on commit 5054743

Please sign in to comment.