IAstroService
katanakit-js / IAstroService
Interface: IAstroService
Section titled “Interface: IAstroService”Defined in: types/adapters/astro.ts:39
Contract of the Astro facade.
Methods
Section titled “Methods”useExtractUniqueValues()
Section titled “useExtractUniqueValues()”useExtractUniqueValues<T, V>(items, keyFrom): V[];Defined in: types/adapters/astro.ts:63
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T |
V |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
items |
T[] |
keyFrom |
(item) => V | V[] |
Returns
Section titled “Returns”V[]
useFindEntry()
Section titled “useFindEntry()”useFindEntry<T>( items, value, keyFrom?): T | null;Defined in: types/adapters/astro.ts:53
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
items |
T[] |
value |
string |
keyFrom? |
(item) => string | number |
Returns
Section titled “Returns”T | null
useGeneratePagination()
Section titled “useGeneratePagination()”useGeneratePagination<T, TParam>( items, pageSize?, param?): AstroPath<TParam, PaginationProps<T>>[];Defined in: types/adapters/astro.ts:54
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T |
- |
TParam extends string |
"page" |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
items |
T[] |
pageSize? |
number |
param? |
TParam |
Returns
Section titled “Returns”AstroPath<TParam, PaginationProps<T>>[]
useGetStaticPaths()
Section titled “useGetStaticPaths()”useGetStaticPaths<TData, TParam, TProps>( getCollectionFn, collectionName, options?): Promise<AstroServiceResult<AstroPath<TParam, TProps>[]>>;Defined in: types/adapters/astro.ts:44
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
TData |
unknown |
TParam extends string |
"slug" |
TProps |
CollectionEntryLike<TData> |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
getCollectionFn |
(collection) => Promise<CollectionEntryLike<TData>[]> |
collectionName |
string |
options? |
PathsOptions<CollectionEntryLike<TData>, TParam, TProps> |
Returns
Section titled “Returns”Promise<AstroServiceResult<AstroPath<TParam, TProps>[]>>
usePathsFrom()
Section titled “usePathsFrom()”usePathsFrom<T, TParam, TProps>(items, options?): AstroPath<TParam, TProps>[];Defined in: types/adapters/astro.ts:40
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T |
- |
TParam extends string |
"slug" |
TProps |
T |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
items |
T[] |
options? |
PathsOptions<T, TParam, TProps> |
Returns
Section titled “Returns”AstroPath<TParam, TProps>[]
usePathsFromValues()
Section titled “usePathsFromValues()”usePathsFromValues<TParam>(values, param?): AstroPath<TParam, string | number>[];Defined in: types/adapters/astro.ts:59
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
TParam extends string |
"slug" |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
values |
(string | number)[] |
param? |
TParam |
Returns
Section titled “Returns”AstroPath<TParam, string | number>[]