Skip to content

Commit

Permalink
fix: Lowercase 'Object' keyword.
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Apr 5, 2024
1 parent e4c5887 commit e42615d
Show file tree
Hide file tree
Showing 8 changed files with 70 additions and 70 deletions.
24 changes: 12 additions & 12 deletions docs/pages/api-docs/Class.MarkdownThemeRenderContext.md
Expand Up @@ -66,7 +66,7 @@ Holds the textmappings object of the theme.

### packagesMetaData

> **`readonly`** **packagesMetaData**: `Record`\<`string`, `Object`\>
> **`readonly`** **packagesMetaData**: `Record`\<`string`, `object`\>
Holds meta data for individual packages (if entryPointStrategy equals `packages`).

Expand All @@ -78,7 +78,7 @@ Theme resources are the main building blocks for the theme context. They are spl

### templates

> **templates**: `Object`
> **templates**: `object`
Then `templates` namespace holds the main templates for the theme and are mapped to single pages and configured in the MarkdownTheme.

Expand Down Expand Up @@ -112,7 +112,7 @@ All templates return a string that is passed back to the renderer. Internally te

### partials

> **partials**: `Object`
> **partials**: `object`
Then `partials` namespace holds the partials for the theme and are used by templates to map speficic models to page output.

Expand Down Expand Up @@ -274,7 +274,7 @@ Renders an constructor member.

##### declaration()

> **declaration**: (`model`: [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html), `options`: `Object`) => `string`
> **declaration**: (`model`: [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html), `options`: `object`) => `string`
Renders a standard declaration member.

Expand All @@ -283,7 +283,7 @@ Renders a standard declaration member.
| Parameter | Type |
| :------ | :------ |
| `model` | [`DeclarationReflection`](https://typedoc.org/api/classes/Models.DeclarationReflection.html) |
| `options` | `Object` |
| `options` | `object` |
| `options.headingLevel` | `number` |
| `options.nested`? | `boolean` |

Expand Down Expand Up @@ -556,14 +556,14 @@ Renders a signature member.

##### signatureTitle()

> **signatureTitle**: (`signature`: `SignatureReflection`, `opts`?: `Object`) => `string`
> **signatureTitle**: (`signature`: `SignatureReflection`, `opts`?: `object`) => `string`
###### Parameters

| Parameter | Type |
| :------ | :------ |
| `signature` | `SignatureReflection` |
| `opts`? | `Object` |
| `opts`? | `object` |
| `opts.accessor`? | `string` |
| `opts.includeType`? | `boolean` |

Expand Down Expand Up @@ -697,14 +697,14 @@ Renders a signature member.

##### comment()

> **comment**: (`model`: `Comment`, `options`: `Object`) => `string`
> **comment**: (`model`: `Comment`, `options`: `object`) => `string`
###### Parameters

| Parameter | Type |
| :------ | :------ |
| `model` | `Comment` |
| `options` | `Object` |
| `options` | `object` |
| `options.headingLevel`? | `number` |
| `options.showSummary`? | `boolean` |
| `options.showTags`? | `boolean` |
Expand Down Expand Up @@ -989,7 +989,7 @@ Takes a generic Type and returns the appropriate partial for it.

### helpers

> **helpers**: `Object`
> **helpers**: `object`
Then `helpers` namespace holds the helpers for the theme and are smaller utility functions that return snippets or text or other data transformations.

Expand Down Expand Up @@ -1070,7 +1070,7 @@ Helpers can return any value types.

#### getPackagesMeta()

> **getPackagesMeta**: (`key`: `string`) => `Object`
> **getPackagesMeta**: (`key`: `string`) => `object`
##### Parameters

Expand All @@ -1080,7 +1080,7 @@ Helpers can return any value types.

##### Returns

`Object`
`object`

###### options

Expand Down
Expand Up @@ -20,5 +20,5 @@ export function reflectionType(

return expandObjects
? context.partials.declarationType(root)
: backTicks('Object');
: backTicks('object');
}
Expand Up @@ -425,11 +425,11 @@ Some nested params.
| Parameter | Type | Description |
| :------ | :------ | :------ |
| \`params\` | \`Object\` | The parameters passed to the method. |
| \`params\` | \`object\` | The parameters passed to the method. |
| \`params.name\` | \`string\` | The name of the new group. |
| \`params.nestedObj\` | \`Object\` | A nested object. |
| \`params.nestedObj\` | \`object\` | A nested object. |
| \`params.nestedObj.name\`? | \`string\` | - |
| \`params.nestedObj.obj\`? | \`Object\` | - |
| \`params.nestedObj.obj\`? | \`object\` | - |
| \`params.nestedObj.obj.name\`? | () => \`void\` | - |
| \`params.nestedObj.value\`? | \`number\` | - |
| \`params.parent\`? | \`number\` | - |
Expand Down
Expand Up @@ -113,7 +113,7 @@ Comments for BasicClass
### objecLiteralProp
> **objecLiteralProp**: \`Object\`
> **objecLiteralProp**: \`object\`
#### someFunction()
Expand Down Expand Up @@ -174,7 +174,7 @@ new BasicClass(): BasicClass
| Property | Type | Description |
| :------ | :------ | :------ |
| \`objecLiteralProp\` | \`Object\` | - |
| \`objecLiteralProp\` | \`object\` | - |
| \`objecLiteralProp.someFunction\` | (\`a\`: \`string\`) => \`string\` | Comments for someFunction |
| \`objecLiteralProp.someProp\` | \`string\` | Comments for someProp |
| \`someProp\` | \`string\` | Comments for prop1 |
Expand Down
Expand Up @@ -69,13 +69,13 @@ Comments for function
exports[`Function Reflection should compile function returning a promise: (Output File Strategy "members") (Option Group "1") 1`] = `
"# Function: functionReturningAPromise()
> **functionReturningAPromise**(): [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`Object\`\\>
> **functionReturningAPromise**(): [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`object\`\\>
Comments for function
## Returns
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`Object\`\\>
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`object\`\\>
Return comments
Expand All @@ -94,14 +94,14 @@ exports[`Function Reflection should compile function returning a promise: (Outpu
"# functionReturningAPromise()
\`\`\`ts
functionReturningAPromise(): Promise<Object>
functionReturningAPromise(): Promise<object>
\`\`\`
Comments for function
## Returns
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`Object\`\\>
[\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`object\`\\>
Return comments
Expand Down Expand Up @@ -199,13 +199,13 @@ Return comments
exports[`Function Reflection should compile function returning an object: (Output File Strategy "members") (Option Group "1") 1`] = `
"# Function: functionReturningAnObject()
> **functionReturningAnObject**(): \`Object\`
> **functionReturningAnObject**(): \`object\`
Comments for function
## Returns
\`Object\`
\`object\`
Return comments
Expand Down Expand Up @@ -233,14 +233,14 @@ exports[`Function Reflection should compile function returning an object: (Outpu
"# functionReturningAnObject()
\`\`\`ts
functionReturningAnObject(): Object
functionReturningAnObject(): object
\`\`\`
Comments for function
## Returns
\`Object\`
\`object\`
Return comments
Expand Down Expand Up @@ -338,7 +338,7 @@ exports[`Function Reflection should compile function with complex params: (Outpu
"# functionWithComplexParams()
\`\`\`ts
functionWithComplexParams(paramA: (a: string) => true, paramB: Object): boolean
functionWithComplexParams(paramA: (a: string) => true, paramB: object): boolean
\`\`\`
Function with function parmas
Expand All @@ -348,7 +348,7 @@ Function with function parmas
| Parameter | Type |
| :------ | :------ |
| \`paramA\` | (\`a\`: \`string\`) => \`true\` |
| \`paramB\` | \`Object\` |
| \`paramB\` | \`object\` |
| \`paramB.x\` | \`1\` |
## Returns
Expand Down Expand Up @@ -515,7 +515,7 @@ This is the first signature of a function with multiple signatures.
## functionWithMultipleSignatures(value)
\`\`\`ts
functionWithMultipleSignatures(value: Object): string
functionWithMultipleSignatures(value: object): string
\`\`\`
This is the second signature of a function with multiple signatures.
Expand All @@ -524,7 +524,7 @@ This is the second signature of a function with multiple signatures.
| Parameter | Type | Description |
| :------ | :------ | :------ |
| \`value\` | \`Object\` | An object containing the name value. |
| \`value\` | \`object\` | An object containing the name value. |
| \`value.name\` | \`string\` | A value of the object. |
### Returns
Expand Down Expand Up @@ -570,14 +570,14 @@ exports[`Function Reflection should compile function with named params: (Output
"# functionWithNamedParams()
\`\`\`ts
functionWithNamedParams(__namedParameters: Object, anotherParam: string): void
functionWithNamedParams(__namedParameters: object, anotherParam: string): void
\`\`\`
## Parameters
| Parameter | Type | Description |
| :------ | :------ | :------ |
| \`__namedParameters\` | \`Object\` | various options |
| \`__namedParameters\` | \`object\` | various options |
| \`__namedParameters.bar\`? | \`number\` | - |
| \`__namedParameters.foo\`? | \`number\` | - |
| \`anotherParam\` | \`string\` | Another param comment |
Expand Down Expand Up @@ -644,7 +644,7 @@ exports[`Function Reflection should compile function with nested parameters: (Ou
\`\`\`ts
functionWithNestedParameters(
params: Object,
params: object,
context: any,
somethingElse?: string): boolean
\`\`\`
Expand All @@ -655,11 +655,11 @@ Some nested params.
| Parameter | Type | Description |
| :------ | :------ | :------ |
| \`params\` | \`Object\` | The parameters passed to the method. |
| \`params\` | \`object\` | The parameters passed to the method. |
| \`params.name\` | \`string\` | The name of the new group. |
| \`params.nestedObj\` | \`Object\` | A nested object. |
| \`params.nestedObj\` | \`object\` | A nested object. |
| \`params.nestedObj.name\`? | \`string\` | - |
| \`params.nestedObj.obj\`? | \`Object\` | - |
| \`params.nestedObj.obj\`? | \`object\` | - |
| \`params.nestedObj.obj.name\`? | () => \`void\` | - |
| \`params.nestedObj.value\`? | \`number\` | - |
| \`params.parent\`? | \`number\` | - |
Expand Down

0 comments on commit e42615d

Please sign in to comment.