docs: add ignore tag to isPaymentProcessor (#6410)

- Add ignore tags to `isPaymentProcessor` method and property
- Generate payment reference to move the associated section.
This commit is contained in:
Shahed Nasser
2024-02-16 14:51:14 +02:00
committed by GitHub
parent 35a4db29b7
commit 0d68eadf84
4 changed files with 12 additions and 77 deletions

View File

@@ -2515,55 +2515,6 @@
"package": "typescript"
}
},
{
"id": 62,
"name": "_isPaymentProcessor",
"variant": "declaration",
"kind": 1024,
"flags": {
"isStatic": true
},
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "true"
},
{
"id": 63,
"name": "isPaymentProcessor",
"variant": "declaration",
"kind": 2048,
"flags": {
"isStatic": true
},
"signatures": [
{
"id": 64,
"name": "isPaymentProcessor",
"variant": "signature",
"kind": 4096,
"flags": {},
"parameters": [
{
"id": 65,
"name": "object",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
}
],
"type": {
"type": "intrinsic",
"name": "boolean"
}
}
]
},
{
"id": 66,
"name": "identifier",
@@ -4207,14 +4158,12 @@
"children": [
71,
72,
62,
66
]
},
{
"title": "Methods",
"children": [
63,
75,
78,
85,
@@ -4543,22 +4492,6 @@
"sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts",
"qualifiedName": "AbstractPaymentProcessor"
},
"62": {
"sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts",
"qualifiedName": "AbstractPaymentProcessor._isPaymentProcessor"
},
"63": {
"sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts",
"qualifiedName": "AbstractPaymentProcessor.isPaymentProcessor"
},
"64": {
"sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts",
"qualifiedName": "AbstractPaymentProcessor.isPaymentProcessor"
},
"65": {
"sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts",
"qualifiedName": "object"
},
"66": {
"sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts",
"qualifiedName": "AbstractPaymentProcessor.identifier"

View File

@@ -676,8 +676,14 @@ export abstract class AbstractPaymentProcessor implements PaymentProcessor {
protected readonly config?: Record<string, unknown> // eslint-disable-next-line @typescript-eslint/no-empty-function
) {}
/**
* @ignore
*/
static _isPaymentProcessor = true
/**
* @ignore
*/
static isPaymentProcessor(object): boolean {
return object?.constructor?._isPaymentProcessor
}

View File

@@ -41,8 +41,14 @@ export abstract class AbstractPaymentProvider implements IPaymentProvider {
protected readonly config?: Record<string, unknown> // eslint-disable-next-line @typescript-eslint/no-empty-function
) {}
/**
* @ignore
*/
static _isPaymentProvider = true
/**
* @ignore
*/
static isPaymentProvider(object): boolean {
return object?.constructor?._isPaymentProvider
}

View File

@@ -143,16 +143,6 @@ ___
## Methods
### isPaymentProcessor
#### Parameters
<ParameterTypes parameters={[{"name":"object","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="isPaymentProcessor"/>
#### Returns
<ParameterTypes parameters={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="isPaymentProcessor"/>
### capturePayment
This method is used to capture the payment amount of an order. This is typically triggered manually by the store operator from the admin.