Skip to content

Improve JSDoc documentation #1796

New issue
New issue
Open
Open
Improve JSDoc documentation#1796
Labels
documentationImprovements or additions to documentation
@flevi29

Description

@flevi29
flevi29
opened on Dec 6, 2024

JSDoc documentation is missing for most exported symbols, and could use some improvements on existing ones.
In addition, I think most methods that are already documented on the API reference page, should just link to it, rather than having extra documentation, reducing maintenance requirements.

JSR should keep track of the missing documentation problems once #1841 is merged, but until then the following command does:

deno doc --lint --unstable-sloppy-imports ./src/index.ts 
error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\meilisearch.ts:42:1
   |
42 | export class MeiliSearch {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\meilisearch.ts:43:3
   |
43 |   config: Config;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\meilisearch.ts:44:3
   |
44 |   httpRequest: HttpRequests;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\meilisearch.ts:45:3
   |
45 |   tasks: TaskClient;
   |   ^


error[private-type-ref]: public type 'MeiliSearch.prototype.batches' references private type 'BatchClient'
  --> C:\Users\delza\meilisearch-js\src\meilisearch.ts:46:3
   |
46 |   batches: BatchClient;
   |   ^
   = hint: make the referenced type public or remove the reference
   |
30 | class BatchClient {
   | - this is the referenced type
   |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\meilisearch.ts:46:3
   |
46 |   batches: BatchClient;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:10:1
   |
10 | export type Config = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:23:1
   |
23 | export type Pagination = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:28:1
   |
28 | export type ResourceQuery = Pagination & {};
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:30:1
   |
30 | export type ResourceResults<T> = Pagination & {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:39:1
   |
39 | export type IndexOptions = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:43:1
   |
43 | export type IndexObject = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:50:1
   |
50 | export type IndexesQuery = ResourceQuery & {};
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:52:1
   |
52 | export type IndexesResults<T> = ResourceResults<T> & {};
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:58:14
   |
58 | export const MatchingStrategies = {
   |              ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:64:1
   |
64 | export type MatchingStrategies =
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:67:1
   |
67 | export type Filter = string | Array<string | string[]>;
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:69:1
   |
69 | export type Query = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:73:1
   |
73 | export type Highlight = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:79:1
   |
79 | export type Crop = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:86:1
   |
86 | export type SearchForFacetValuesParams = Omit<SearchParams, "facetName"> & {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:90:1
   |
90 | export type FacetHit = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\types.ts:95:1
   |
95 | export type SearchForFacetValuesResponse = {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:101:1
    |
101 | export type HybridSearch = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:107:1
    |
107 | export type Locale = string;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:109:1
    |
109 | export type SearchParams = Query &
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:136:1
    |
136 | export type SearchRequestGET = Pagination &
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:157:1
    |
157 | export type MergeFacets = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:161:1
    |
161 | export type FederationOptions = { weight: number };
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:162:1
    |
162 | export type MultiSearchFederation = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:169:1
    |
169 | export type MultiSearchQuery = SearchParams & { indexUid: string };
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:170:1
    |
170 | export type MultiSearchQueryWithFederation = MultiSearchQuery & {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:174:1
    |
174 | export type MultiSearchParams = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:177:1
    |
177 | export type FederatedMultiSearchParams = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:182:1
    |
182 | export type CategoriesDistribution = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:186:1
    |
186 | export type Facet = string;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:187:1
    |
187 | export type FacetDistribution = Record<Facet, CategoriesDistribution>;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:188:1
    |
188 | export type MatchesPosition<T> = Partial<
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:192:1
    |
192 | export type RankingScoreDetails = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:223:1
    |
223 | export type FederationDetails = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:229:1
    |
229 | export type Hit<T = Record<string, any>> = T & {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:237:1
    |
237 | export type Hits<T = Record<string, any>> = Array<Hit<T>>;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:239:1
    |
239 | export type FacetStat = { min: number; max: number };
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:240:1
    |
240 | export type FacetStats = Record<string, FacetStat>;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:242:1
    |
242 | export type FacetsByIndex = Record<
    | ^


error[private-type-ref]: public type 'SearchResponse' references private type 'FinitePagination'
   --> C:\Users\delza\meilisearch-js\src\types.ts:250:1
    |
250 | export type SearchResponse<
    | ^
    = hint: make the referenced type public or remove the reference
    |
266 | type FinitePagination = {
    | - this is the referenced type
    |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[private-type-ref]: public type 'SearchResponse' references private type 'InfinitePagination'
   --> C:\Users\delza\meilisearch-js\src\types.ts:250:1
    |
250 | export type SearchResponse<
    | ^
    = hint: make the referenced type public or remove the reference
    |
272 | type InfinitePagination = {
    | - this is the referenced type
    |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[private-type-ref]: public type 'SearchResponse' references private type 'IsFinitePagination'
   --> C:\Users\delza\meilisearch-js\src\types.ts:250:1
    |
250 | export type SearchResponse<
    | ^
    = hint: make the referenced type public or remove the reference
    |
278 | type IsFinitePagination<S extends SearchParams> = Or<
    | - this is the referenced type
    |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:250:1
    |
250 | export type SearchResponse<
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:297:1
    |
297 | export type MultiSearchResult<T> = SearchResponse<T> & { indexUid: string };
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:299:1
    |
299 | export type MultiSearchResponse<T = Record<string, any>> = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:303:1
    |
303 | export type MultiSearchResponseOrSearchResponse<
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:310:1
    |
310 | export type FieldDistribution = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:314:1
    |
314 | export type SearchSimilarDocumentsParams = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:334:1
    |
334 | export type DocumentOptions = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:338:14
    |
338 | export const ContentTypeEnum: Readonly<Record<string, ContentType>> = {
    |              ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:344:1
    |
344 | export type ContentType =
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:349:1
    |
349 | export type RawDocumentAdditionOptions = DocumentOptions & {
    | ^


error[private-type-ref]: public type 'DocumentsQuery' references private type 'Fields'
   --> C:\Users\delza\meilisearch-js\src\types.ts:353:1
    |
353 | export type DocumentsQuery<T = Record<string, any>> = ResourceQuery & {
    | ^
    = hint: make the referenced type public or remove the reference
    |
330 | type Fields<T = Record<string, any>> =
    | - this is the referenced type
    |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:353:1
    |
353 | export type DocumentsQuery<T = Record<string, any>> = ResourceQuery & {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:361:1
    |
361 | export type DocumentQuery<T = Record<string, any>> = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:365:1
    |
365 | export type DocumentsDeletionQuery = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:369:1
    |
369 | export type DocumentsIds = string[] | number[];
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:371:1
    |
371 | export type UpdateDocumentsByFunctionOptions = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:381:1
    |
381 | export type FilterableAttributes = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:382:1
    |
382 | export type DistinctAttribute = string | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:383:1
    |
383 | export type SearchableAttributes = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:384:1
    |
384 | export type SortableAttributes = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:385:1
    |
385 | export type DisplayedAttributes = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:386:1
    |
386 | export type RankingRules = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:387:1
    |
387 | export type StopWords = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:388:1
    |
388 | export type Synonyms = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:391:1
    |
391 | export type TypoTolerance = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:400:1
    |
400 | export type SeparatorTokens = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:401:1
    |
401 | export type NonSeparatorTokens = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:402:1
    |
402 | export type Dictionary = string[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:403:1
    |
403 | export type ProximityPrecision = "byWord" | "byAttribute";
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:405:1
    |
405 | export type Distribution = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:410:1
    |
410 | export type OpenAiEmbedder = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:422:1
    |
422 | export type HuggingFaceEmbedder = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:432:1
    |
432 | export type UserProvidedEmbedder = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:439:1
    |
439 | export type RestEmbedder = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:453:1
    |
453 | export type OllamaEmbedder = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:465:1
    |
465 | export type Embedder =
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:473:1
    |
473 | export type Embedders = Record<string, Embedder> | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:475:1
    |
475 | export type FacetOrder = "alpha" | "count";
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:477:1
    |
477 | export type Faceting = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:482:1
    |
482 | export type PaginationSettings = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:486:1
    |
486 | export type SearchCutoffMs = number | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:488:1
    |
488 | export type LocalizedAttribute = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:493:1
    |
493 | export type LocalizedAttributes = LocalizedAttribute[] | null;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:495:1
    |
495 | export type PrefixSearch = "indexingTime" | "disabled";
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:497:1
    |
497 | export type Settings = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:533:14
    |
533 | export const TaskStatus = {
    |              ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:541:1
    |
541 | export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:543:14
    |
543 | export const TaskTypes = {
    |              ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:557:1
    |
557 | export type TaskTypes = (typeof TaskTypes)[keyof typeof TaskTypes];
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:559:1
    |
559 | export type TasksQuery = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:580:1
    |
580 | export type CancelTasksQuery = Omit<TasksQuery, "limit" | "from"> & {};
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:582:1
    |
582 | export type DeleteTasksQuery = Omit<TasksQuery, "limit" | "from"> & {};
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:584:1
    |
584 | export type EnqueuedTaskObject = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:593:1
    |
593 | export type TaskObject = Omit<EnqueuedTaskObject, "taskUid"> & {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:658:1
    |
658 | export type SwapIndexesParams = Array<{
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:670:1
    |
670 | export type TasksResults = CursorResults<Task>;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:671:1
    |
671 | export type TasksResultsObject = CursorResults<TaskObject>;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:673:1
    |
673 | export type WaitOptions = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:749:1
    |
749 | export type BatchesQuery = {
    | ^


error[private-type-ref]: public type 'BatchesResults' references private type 'Batch'
   --> C:\Users\delza\meilisearch-js\src\types.ts:767:1
    |
767 | export type BatchesResults = CursorResults<Batch>;
    | ^
    = hint: make the referenced type public or remove the reference
    |
 10 | class Batch {
    | - this is the referenced type
    |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:767:1
    |
767 | export type BatchesResults = CursorResults<Batch>;
    | ^


error[private-type-ref]: public type 'BatchesResultsObject' references private type 'CursorResults'
   --> C:\Users\delza\meilisearch-js\src\types.ts:768:1
    |
768 | export type BatchesResultsObject = CursorResults<BatchObject>;
    | ^
    = hint: make the referenced type public or remove the reference
    |
662 | type CursorResults<T> = {
    | - this is the referenced type
    |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:768:1
    |
768 | export type BatchesResultsObject = CursorResults<BatchObject>;
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:774:1
    |
774 | export type Health = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:782:1
    |
782 | export type IndexStats = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:788:1
    |
788 | export type Stats = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:800:1
    |
800 | export type Key = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:812:1
    |
812 | export type KeyCreation = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:821:1
    |
821 | export type KeyUpdate = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:826:1
    |
826 | export type KeysQuery = ResourceQuery & {};
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:828:1
    |
828 | export type KeysResults = ResourceResults<Key[]> & {};
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:833:1
    |
833 | export type Version = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:843:1
    |
843 | export interface FetchError extends Error {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:844:3
    |
844 |   type: string;
    |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:845:3
    |
845 |   errno: string;
    |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:846:3
    |
846 |   code: string;
    |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:849:1
    |
849 | export type MeiliSearchErrorResponse = {
    | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
   --> C:\Users\delza\meilisearch-js\src\types.ts:859:14
    |
859 | export const ErrorStatusCode = {
    |              ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
    --> C:\Users\delza\meilisearch-js\src\types.ts:1221:1
     |
1221 | export type ErrorStatusCode =
     | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
    --> C:\Users\delza\meilisearch-js\src\types.ts:1225:1
     |
1225 | export type TokenIndexRules = { filter?: Filter };
     | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:64:1
   |
64 | class Index<T extends Record<string, any> = Record<string, any>> {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:65:3
   |
65 |   uid: string;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:66:3
   |
66 |   primaryKey: string | undefined;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:67:3
   |
67 |   createdAt: Date | undefined;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:68:3
   |
68 |   updatedAt: Date | undefined;
   |   ^


error[private-type-ref]: public type 'Index.prototype.httpRequest' references private type 'HttpRequests'
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:69:3
   |
69 |   httpRequest: HttpRequests;
   |   ^
   = hint: make the referenced type public or remove the reference
   |
92 | class HttpRequests {
   | - this is the referenced type
   |

  info: to ensure documentation is complete all types that are exposed in the public API must be public


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:69:3
   |
69 |   httpRequest: HttpRequests;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:70:3
   |
70 |   tasks: TaskClient;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\indexes.ts:77:3
   |
77 |   constructor(config: Config, uid: string, primaryKey?: string) {
   |   ^


error[missing-explicit-type]: exported symbol is missing an explicit type annotation
  --> C:\Users\delza\meilisearch-js\src\index.ts:14:7
   |
14 | const defaultExport = MeiliSearch;
   |       ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-api-error.ts:4:1
  |
4 | export class MeiliSearchApiError extends MeiliSearchError {
  | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-api-error.ts:5:3
  |
5 |   override name = "MeiliSearchApiError";
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-api-error.ts:6:3
  |
6 |   override cause?: MeiliSearchErrorResponse;
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-api-error.ts:7:3
  |
7 |   readonly response: Response;
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-api-error.ts:9:3
  |
9 |   constructor(response: Response, responseBody?: MeiliSearchErrorResponse) {
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-request-error.ts:3:1
  |
3 | export class MeiliSearchRequestError extends MeiliSearchError {
  | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-request-error.ts:4:3
  |
4 |   override name = "MeiliSearchRequestError";
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-request-error.ts:6:3
  |
6 |   constructor(url: string, cause: unknown) {
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-error.ts:1:1
  |
1 | export class MeiliSearchError extends Error {
  | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-error.ts:2:3
  |
2 |   override name = "MeiliSearchError";
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-error.ts:4:3
  |
4 |   constructor(...params: ConstructorParameters<typeof Error>) {
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-timeout-error.ts:3:1
  |
3 | export class MeiliSearchTimeOutError extends MeiliSearchError {
  | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-timeout-error.ts:4:3
  |
4 |   override name = "MeiliSearchTimeOutError";
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\meilisearch-timeout-error.ts:6:3
  |
6 |   constructor(message: string) {
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\errors\version-hint-message.ts:1:1
  |
1 | export function versionErrorHintMessage(message: string, method: string) {
  | ^


error[missing-return-type]: exported function is missing an explicit return type annotation
 --> C:\Users\delza\meilisearch-js\src\errors\version-hint-message.ts:1:1
  |
1 | export function versionErrorHintMessage(message: string, method: string) {
  | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\enqueued-task.ts:3:1
  |
3 | class EnqueuedTask {
  | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\enqueued-task.ts:4:3
  |
4 |   taskUid: EnqueuedTaskObject["taskUid"];
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\enqueued-task.ts:5:3
  |
5 |   indexUid: EnqueuedTaskObject["indexUid"];
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\enqueued-task.ts:6:3
  |
6 |   status: EnqueuedTaskObject["status"];
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\enqueued-task.ts:7:3
  |
7 |   type: EnqueuedTaskObject["type"];
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
 --> C:\Users\delza\meilisearch-js\src\enqueued-task.ts:8:3
  |
8 |   enqueuedAt: Date;
  |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\enqueued-task.ts:10:3
   |
10 |   constructor(task: EnqueuedTaskObject) {
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:17:1
   |
17 | class Task {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:18:3
   |
18 |   indexUid: TaskObject["indexUid"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:19:3
   |
19 |   status: TaskObject["status"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:20:3
   |
20 |   type: TaskObject["type"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:21:3
   |
21 |   uid: TaskObject["uid"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:22:3
   |
22 |   batchUid: TaskObject["batchUid"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:23:3
   |
23 |   canceledBy: TaskObject["canceledBy"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:24:3
   |
24 |   details: TaskObject["details"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:25:3
   |
25 |   error: TaskObject["error"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:26:3
   |
26 |   duration: TaskObject["duration"];
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:27:3
   |
27 |   startedAt: Date;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:28:3
   |
28 |   enqueuedAt: Date;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:29:3
   |
29 |   finishedAt: Date;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:31:3
   |
31 |   constructor(task: TaskObject) {
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:48:1
   |
48 | class TaskClient {
   | ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:49:3
   |
49 |   httpRequest: HttpRequests;
   |   ^


error[missing-jsdoc]: exported symbol is missing JSDoc documentation
  --> C:\Users\delza\meilisearch-js\src\task.ts:51:3
   |
51 |   constructor(config: Config) {
   |   ^


error: Found 178 documentation lint errors.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions