Document list options

[peterpeterparker]

The various options available to listDocs and listAssets - the parameters - are not documented well enough on the website.

This feature request as for goal to improve their documentation including usage/example.

This is the TS code of the parameters.

export interface ListPaginate {
  startAfter?: string;
  limit?: number;
}

export type ListOrderField = 'keys' | 'updated_at' | 'created_at';

export interface ListOrder {
  desc: boolean;
  field: ListOrderField;
}

export type ListOwner = string | Principal;

export interface ListMatcher {
  key?: string;
  description?: string;
}

export interface ListParams {
  matcher?: ListMatcher;
  paginate?: ListPaginate;
  order?: ListOrder;
  owner?: ListOwner;
}

[Etette]

can you assign me this?

[peterpeterparker]

Sure thanks!

The pages/sections to improve are the following: listDocs and listAssets

Let me know if you have questions.

[Demali-876]

Hello has this issue been resolved?

[peterpeterparker]

@Demali-876 thanks. Yes it's still available! If you can take care of it that would be wonderful.

[Demali-876]

@peterpeterparker No problem, how/where do i have access to make the changes? Are there guidelines to follow?

[peterpeterparker]

@Demali-876 there is no guidelines but, nothing particular to know. Standard contribution flow.

1. Fork this repo
2. Clone the project afterwards on your machine
3. Edit the changes
4. Create a branch and commit your changes
5. Provide the changes as a PR

You can find the options to describe in this declarations file: https://github.com/junobuild/juno-js/blob/f2456fde5e2c9e6e7abe66c7f13323fc4c33ddd3/packages/core/src/types/list.types.ts#L110

The options have to be documented in the "List" chapter of following page, maybe in form of a table:

Datastore: https://github.com/junobuild/docs/blob/main/docs/build/datastore.md#list-documents

Storage: https://github.com/junobuild/docs/blob/main/docs/build/storage.md#list-assets

Let me know if you have more questions and thanks!

[peterpeterparker]

Resolved by @Demali-876 in #135