LemmyNet/lemmy-js-client
2
0
Fork 0
mirror of https://github.com/LemmyNet/lemmy-js-client.git synced 2024-12-23 11:21:27 +00:00
Code Issues Projects Releases Wiki Activity

Use enum types in API. Fixes #51

Browse source
This commit is contained in:
Dessalines 2022-05-15 15:26:40 -04:00
parent 7203e3dce6
commit a8f4298f06
5 changed files with 17 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
src/interfaces/api/comment.ts
View file

@ -1,3 +1,4 @@
import { ListingType, SortType } from "../others";
import { CommentReportView, CommentView } from "../views"; import { CommentReportView, CommentView } from "../views";
export interface CreateComment { export interface CreateComment {
@ -77,14 +78,8 @@ export interface CreateCommentLike {
* To get posts for a federated community by name, use `name@instance.tld` . * To get posts for a federated community by name, use `name@instance.tld` .
*/ */
export interface GetComments { export interface GetComments {
/** type_?: ListingType;
* The [[ListingType]]. sort?: SortType;
*/
type_?: string;
/**
* The [[SortType]].
*/
sort?: string;
page?: number; page?: number;
limit?: number; limit?: number;
community_id?: number; community_id?: number;

12
src/interfaces/api/community.ts
View file

@ -1,3 +1,4 @@
import { ListingType, SortType } from "../others";
import { Site } from "../source"; import { Site } from "../source";
import { import {
CommunityModeratorView, CommunityModeratorView,
@ -39,15 +40,8 @@ export interface CommunityResponse {
} }
export interface ListCommunities { export interface ListCommunities {
/** type_?: ListingType;
* The [[ListingType]]. sort?: SortType;
*/
type_?: string;
/**
* The [[SortType]].
*/
sort?: string;
page?: number; page?: number;
limit?: number; limit?: number;
auth?: string; auth?: string;

13
src/interfaces/api/person.ts
View file

@ -1,3 +1,4 @@
import { SortType } from "../others";
import { import {
CommentView, CommentView,
CommunityModeratorView, CommunityModeratorView,
@ -127,7 +128,7 @@ export interface GetPersonDetails {
* To get details for a federated user, use `person@instance.tld`. * To get details for a federated user, use `person@instance.tld`.
*/ */
username?: string; username?: string;
sort?: string; sort?: SortType;
page?: number; page?: number;
limit?: number; limit?: number;
community_id?: number; community_id?: number;
@ -186,10 +187,7 @@ export interface BanPersonResponse {
} }
export interface GetReplies { export interface GetReplies {
/** sort?: SortType;
* The [[SortType]].
*/
sort?: string;
page?: number; page?: number;
limit?: number; limit?: number;
unread_only?: boolean; unread_only?: boolean;
@ -197,10 +195,7 @@ export interface GetReplies {
} }
export interface GetPersonMentions { export interface GetPersonMentions {
/** sort?: SortType;
* The [[SortType]].
*/
sort?: string;
page?: number; page?: number;
limit?: number; limit?: number;
unread_only?: boolean; unread_only?: boolean;

14
src/interfaces/api/post.ts
View file

@ -1,4 +1,4 @@
import { SiteMetadata } from ".."; import { ListingType, SiteMetadata, SortType } from "../others";
import { import {
CommentView, CommentView,
CommunityModeratorView, CommunityModeratorView,
@ -35,16 +35,8 @@ export interface GetPostResponse {
} }
export interface GetPosts { export interface GetPosts {
/** type_?: ListingType;
* The [[ListingType]]. sort?: SortType;
*
* Post listing types are `All, Subscribed, Community`
*/
type_?: string;
/**
* The [[SortType]].
*/
sort?: string;
page?: number; page?: number;
limit?: number; limit?: number;
community_id?: number; community_id?: number;

17
src/interfaces/api/site.ts
View file

@ -1,3 +1,4 @@
import { ListingType, SearchType, SortType } from "../others";
import { import {
CommentView, CommentView,
CommunityBlockView, CommunityBlockView,
@ -30,22 +31,12 @@ export interface Search {
* The search query string. * The search query string.
*/ */
q: string; q: string;
type_?: SearchType;
/**
* The [[SearchType]].
*/
type_?: string;
community_id?: number; community_id?: number;
community_name?: string; community_name?: string;
creator_id?: number; creator_id?: number;
/** sort?: SortType;
* The [[SortType]]. listing_type?: ListingType;
*/
sort?: string;
/**
* The [[ListingType]].
*/
listing_type?: string;
page?: number; page?: number;
limit?: number; limit?: number;
auth?: string; auth?: string;