-
Notifications
You must be signed in to change notification settings - Fork 50
/
8.useDirectusItems.md
198 lines (148 loc) · 4.11 KB
/
8.useDirectusItems.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
# `useDirectusItems`
---
> Check out the Directus [Items](https://docs.directus.io/reference/items/) documentation.
### `getItems`
Search for items in a specific collection, [`global search querys`](https://docs.directus.io/reference/query/) can be used
- **Arguments:**
- data: [`DirectusItemRequest`](https:/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#L39)
- **Returns:** `Array<T>`
```vue [pages/articles.vue]
<script setup lang="ts">
const { getItems } = useDirectusItems();
const router = useRouter();
interface Article {
id?: string | number;
title: string;
content: string;
status: string;
}
const fetchArticles = async () => {
try {
const filters = { content: "testcontent", title: "Test1" };
const items = await getItems<Article>({
collection: "News",
params: {
filter: filters,
},
});
} catch (e) {}
};
</script>
```
### `getSingletonItem`
Get object from Singleton marked collection
- **Arguments:**
- data: [`DirectusItemRequest`](https:/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#L39)
- **Returns:** `Object<T>`
```vue [pages/imprint.vue]
<script setup lang="ts">
const { getSingletonItem } = useDirectusItems();
interface Imprint {
id?: string | number;
content: string;
}
const fetchArticle: Article[] = async () => {
try {
const item = await getSingletonItem<Imprint>({
collection: "Imprint",
});
} catch (e) {}
};
</script>
```
### `getItemById`
Search for an item by id in a specific collection
- **Arguments:**
- data: [`DirectusItemRequest`](https:/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#L39)
- **Returns:** `Array`
```vue [pages/article.vue]
<script setup lang="ts">
const { getItemById } = useDirectusItems();
const fetchArticle = async () => {
try {
const item = await getItemById({
collection: "News",
id: "4776864a-75ee-4746-9ef4-bd5c2e38cc66",
});
} catch (e) {}
};
</script>
```
### `createItems`
Create one or multiple items in a specific collection
_Items don't have a pre-defined schema. The format depends completely on how you configured your collections and fields in Directus._
- **Arguments:**
- data: [`DirectusItemCreation`](https:/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#45)
- **Returns:** `Array<T>`
```vue [pages/articles.vue]
<script setup lang="ts">
const { createItems } = useDirectusItems();
interface Article {
id?: string | number;
title: string;
content: string;
status: string;
}
const createArticles: Article[] = async () => {
try {
const items: Article[] = [
{
title: "testitem",
content: "testcontent",
status: "published",
},
{
title: "testitem2",
content: "testcontent2",
status: "published",
},
];
await createItems<Article>({ collection: "News", items });
} catch (e) {}
};
</script>
```
### `deleteItems`
Delete one or multiple items in a specific collection
- **Arguments:**
- data: [`DirectusItemDeletion`](https:/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#55)
- **Returns:** `Empty body`
```vue [pages/articles.vue]
<script setup lang="ts">
const { deleteItems } = useDirectusItems();
const deleteArticles: void = async () => {
try {
const items = ["15", "20", "22"];
await deleteItems({ collection: "News", items });
} catch (e) {}
};
</script>
```
### `updateItem`
Update item in a specific collection
- **Arguments:**
- data: [`DirectusItemUpdate`](https:/Intevel/nuxt-directus/blob/main/src/runtime/types/index.d.ts#50)
- **Returns:** `Array<T>`
```vue [pages/articles.vue]
<script setup lang="ts">
const { updateItem } = useDirectusItems();
interface Article {
id?: string | number;
title: string;
content: string;
status: string;
}
const updateArticles: Article[] = async () => {
try {
const newItem = { title: "This Item was updated" };
await updateItem<Article>({
collection: "News",
id: "itemid",
item: newItem,
});
} catch (e) {}
};
</script>
```
::feedback-box
::