Skip to content

Commit b814feb

Browse files
committed
feat: fixes to typedoc markdown build
1 parent e9ce3be commit b814feb

File tree

94 files changed

+7579
-58
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+7579
-58
lines changed

packages/next-drupal/src/types/next-drupal-base.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export type NextDrupalBaseOptions = {
6161
/**
6262
* Set custom headers for the fetcher.
6363
*
64-
* * **Default value**: { "Content-Type": "application/vnd.api+json", Accept: "application/vnd.api+json" }
64+
* * **Default value**: `{ "Content-Type": "application/vnd.api+json", Accept: "application/vnd.api+json" }`
6565
* * **Required**: *No*
6666
*
6767
* [Documentation](https://next-drupal.org/docs/client/configuration#headers)

www/content/api/README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
**next-drupal**
2+
3+
---
4+
5+
<div align="center">
6+
<img width="100%" alt="Next.js for drupal" src="https://next-drupal.org/images/meta.jpg" />
7+
<h1>Next.js for Drupal</h1>
8+
<h3 align="center">Next-generation front-end for your Drupal site.</h3>
9+
</div>
10+
11+
## Demo
12+
13+
https://demo.next-drupal.org
14+
15+
## Documentation
16+
17+
https://next-drupal.org
18+
19+
## Deploy to Vercel
20+
21+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fchapter-three%2Fnext-drupal-basic-starter&env=NEXT_PUBLIC_DRUPAL_BASE_URL,NEXT_IMAGE_DOMAIN&envDescription=Learn%20more%20about%20environment%20variables&envLink=https%3A%2F%2Fnext-drupal.org%2Fdocs%2Fenvironment-variables&project-name=next-drupal&demo-title=Next.js%20for%20Drupal&demo-description=A%20next-generation%20front-end%20for%20your%20Drupal%20site.&demo-url=https%3A%2F%2Fdemo.next-drupal.org&demo-image=https%3A%2F%2Fnext-drupal.org%2Fimages%2Fdemo-screenshot.jpg)
22+
23+
## Example
24+
25+
A page with all "Article" nodes.
26+
27+
```jsx
28+
import { DrupalClient } from "next-drupal"
29+
30+
const drupal = new DrupalClient("https://cms.next-drupal.org")
31+
32+
export default function BlogPage({ articles }) {
33+
return (
34+
<div>
35+
{articles?.length
36+
? nodes.map((node) => (
37+
<div key={node.id}>
38+
<h1>{node.title}</h1>
39+
</div>
40+
))
41+
: null}
42+
</div>
43+
)
44+
}
45+
46+
export async function getStaticProps(context) {
47+
const articles = await drupal.getResourceCollectionFromContext(
48+
"node--article",
49+
context
50+
)
51+
52+
return {
53+
props: {
54+
articles,
55+
},
56+
}
57+
}
58+
```
59+
60+
## Supporting organizations
61+
62+
Development sponsored by [Chapter Three](https://chapterthree.com)
63+
64+
## Contributing
65+
66+
If you're interested in contributing to Next.js for Drupal, please read the [contributing guidelines](https://github.com/chapter-three/next-drupal/blob/main/CONTRIBUTING.md) before submitting a pull request.
Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
[**next-drupal**](../README.md)
2+
3+
---
4+
5+
[next-drupal](../globals.md) / JsonApiErrors
6+
7+
# Class: JsonApiErrors
8+
9+
Defined in: [packages/next-drupal/src/jsonapi-errors.ts:16](https://github.com/chapter-three/next-drupal/blob/e9ce3be1c38aebdcd2cc8c7ae8d8fa2dab7f46bf/packages/next-drupal/src/jsonapi-errors.ts#L16)
10+
11+
## Extends
12+
13+
- `Error`
14+
15+
## Constructors
16+
17+
### new JsonApiErrors()
18+
19+
> **new JsonApiErrors**(`errors`, `statusCode`, `messagePrefix`): [`JsonApiErrors`](JsonApiErrors.md)
20+
21+
Defined in: [packages/next-drupal/src/jsonapi-errors.ts:20](https://github.com/chapter-three/next-drupal/blob/e9ce3be1c38aebdcd2cc8c7ae8d8fa2dab7f46bf/packages/next-drupal/src/jsonapi-errors.ts#L20)
22+
23+
#### Parameters
24+
25+
##### errors
26+
27+
`string` | [`JsonApiError`](../interfaces/JsonApiError.md)[]
28+
29+
##### statusCode
30+
31+
`number`
32+
33+
##### messagePrefix
34+
35+
`string` = `""`
36+
37+
#### Returns
38+
39+
[`JsonApiErrors`](JsonApiErrors.md)
40+
41+
#### Overrides
42+
43+
`Error.constructor`
44+
45+
## Properties
46+
47+
### errors
48+
49+
> **errors**: `string` \| [`JsonApiError`](../interfaces/JsonApiError.md)[]
50+
51+
Defined in: [packages/next-drupal/src/jsonapi-errors.ts:17](https://github.com/chapter-three/next-drupal/blob/e9ce3be1c38aebdcd2cc8c7ae8d8fa2dab7f46bf/packages/next-drupal/src/jsonapi-errors.ts#L17)
52+
53+
---
54+
55+
### message
56+
57+
> **message**: `string`
58+
59+
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
60+
61+
#### Inherited from
62+
63+
`Error.message`
64+
65+
---
66+
67+
### name
68+
69+
> **name**: `string`
70+
71+
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
72+
73+
#### Inherited from
74+
75+
`Error.name`
76+
77+
---
78+
79+
### stack?
80+
81+
> `optional` **stack**: `string`
82+
83+
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
84+
85+
#### Inherited from
86+
87+
`Error.stack`
88+
89+
---
90+
91+
### statusCode
92+
93+
> **statusCode**: `number`
94+
95+
Defined in: [packages/next-drupal/src/jsonapi-errors.ts:18](https://github.com/chapter-three/next-drupal/blob/e9ce3be1c38aebdcd2cc8c7ae8d8fa2dab7f46bf/packages/next-drupal/src/jsonapi-errors.ts#L18)
96+
97+
---
98+
99+
### prepareStackTrace()?
100+
101+
> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
102+
103+
Defined in: node_modules/@types/node/globals.d.ts:28
104+
105+
Optional override for formatting stack traces
106+
107+
#### Parameters
108+
109+
##### err
110+
111+
`Error`
112+
113+
##### stackTraces
114+
115+
`CallSite`[]
116+
117+
#### Returns
118+
119+
`any`
120+
121+
#### See
122+
123+
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
124+
125+
#### Inherited from
126+
127+
`Error.prepareStackTrace`
128+
129+
---
130+
131+
### stackTraceLimit
132+
133+
> `static` **stackTraceLimit**: `number`
134+
135+
Defined in: node_modules/@types/node/globals.d.ts:30
136+
137+
#### Inherited from
138+
139+
`Error.stackTraceLimit`
140+
141+
## Methods
142+
143+
### captureStackTrace()
144+
145+
> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
146+
147+
Defined in: node_modules/@types/node/globals.d.ts:21
148+
149+
Create .stack property on a target object
150+
151+
#### Parameters
152+
153+
##### targetObject
154+
155+
`object`
156+
157+
##### constructorOpt?
158+
159+
`Function`
160+
161+
#### Returns
162+
163+
`void`
164+
165+
#### Inherited from
166+
167+
`Error.captureStackTrace`
168+
169+
---
170+
171+
### formatMessage()
172+
173+
> `static` **formatMessage**(`errors`): `string`
174+
175+
Defined in: [packages/next-drupal/src/jsonapi-errors.ts:34](https://github.com/chapter-three/next-drupal/blob/e9ce3be1c38aebdcd2cc8c7ae8d8fa2dab7f46bf/packages/next-drupal/src/jsonapi-errors.ts#L34)
176+
177+
#### Parameters
178+
179+
##### errors
180+
181+
`string` | [`JsonApiError`](../interfaces/JsonApiError.md)[]
182+
183+
#### Returns
184+
185+
`string`

0 commit comments

Comments
 (0)