Merge pull request #1872 from h3poteto/feat/search-type

Put type param into options in search

example/typescript/src/mastodon/cancel.ts

@@ -13,7 +13,7 @@ const access_token: string = process.env.MASTODON_ACCESS_TOKEN
 const client = generator('mastodon', BASE_URL, access_token)
 
 client
-  .search('whalebird', 'hashtags', { resolve: true })
+  .search('whalebird', { type: 'hashtags', resolve: true })
   .then((resp: Response<Entity.Results>) => {
     console.log(resp.data.hashtags)
   })

example/typescript/src/misskey/cancel.ts

@@ -4,7 +4,7 @@ const access_token: string = process.env.MISSKEY_ACCESS_TOKEN!
 const client = generator('misskey', 'https://misskey.io', access_token)
 
 client
-  .search('h3poteto', 'accounts')
+  .search('h3poteto', { type: 'accounts' })
   .then(res => console.log(res.data))
   .catch(err => {
     if (isCancel(err)) {

example/typescript/src/pleroma/cancel.ts

@@ -7,7 +7,7 @@ const access_token: string = process.env.PLEROMA_ACCESS_TOKEN!
 const client = generator('pleroma', BASE_URL, access_token)
 
 client
-  .search('whalebird', 'hashtags', { resolve: true })
+  .search('whalebird', { resolve: true })
   .then((resp: Response<Entity.Results>) => {
     console.log(resp.data.hashtags)
   })

megalodon/src/friendica.ts

@@ -2552,7 +2552,7 @@ export default class Friendica implements MegalodonInterface {
    * GET /api/v2/search
    *
    * @param q The search query.
-   * @param type Enum of search target.
+   * @param options.type Enum of search target.
    * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40.
    * @param options.max_id Return results older than this id.
    * @param options.min_id Return results immediately newer than this id.
@@ -2564,8 +2564,8 @@ export default class Friendica implements MegalodonInterface {
    */
   public async search(
     q: string,
-    type: 'accounts' | 'hashtags' | 'statuses',
     options?: {
+      type?: 'accounts' | 'hashtags' | 'statuses'
       limit?: number
       max_id?: string
       min_id?: string
@@ -2577,10 +2577,14 @@ export default class Friendica implements MegalodonInterface {
     }
   ): Promise<Response<Entity.Results>> {
     let params = {
-      q,
-      type
+      q
     }
     if (options) {
+      if (options.type) {
+        params = Object.assign(params, {
+          type: options.type
+        })
+      }
       if (options.limit) {
         params = Object.assign(params, {
           limit: options.limit

megalodon/src/mastodon.ts

@@ -2877,8 +2877,8 @@ export default class Mastodon implements MegalodonInterface {
    */
   public async search(
     q: string,
-    type: 'accounts' | 'hashtags' | 'statuses',
     options?: {
+      type?: 'accounts' | 'hashtags' | 'statuses'
       limit?: number
       max_id?: string
       min_id?: string
@@ -2890,10 +2890,14 @@ export default class Mastodon implements MegalodonInterface {
     }
   ): Promise<Response<Entity.Results>> {
     let params = {
-      q,
-      type
+      q
     }
     if (options) {
+      if (options.type) {
+        params = Object.assign(params, {
+          type: options.type
+        })
+      }
       if (options.limit) {
         params = Object.assign(params, {
           limit: options.limit

megalodon/src/megalodon.ts

@@ -1217,7 +1217,7 @@ export interface MegalodonInterface {
    * Perform a search.
    *
    * @param q The search query.
-   * @param type Enum of search target.
+   * @param options.type Enum of search target.
    * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40.
    * @param options.max_id Return results older than this id.
    * @param options.min_id Return results immediately newer than this id.
@@ -1229,8 +1229,8 @@ export interface MegalodonInterface {
    */
   search(
     q: string,
-    type: 'accounts' | 'hashtags' | 'statuses',
     options?: {
+      type?: 'accounts' | 'hashtags' | 'statuses'
       limit?: number
       max_id?: string
       min_id?: string

megalodon/src/misskey.ts

@@ -1951,8 +1951,8 @@ export default class Misskey implements MegalodonInterface {
   // ======================================
   public async search(
     q: string,
-    type: 'accounts' | 'hashtags' | 'statuses',
-    options?: {
+    options: {
+      type: 'accounts' | 'hashtags' | 'statuses'
       limit?: number
       max_id?: string
       min_id?: string
@@ -1963,7 +1963,7 @@ export default class Misskey implements MegalodonInterface {
       exclude_unreviewed?: boolean
     }
   ): Promise<Response<Entity.Results>> {
-    switch (type) {
+    switch (options.type) {
       case 'accounts': {
         let params = {
           query: q

megalodon/src/pleroma.ts

@@ -2880,7 +2880,7 @@ export default class Pleroma implements MegalodonInterface {
    * GET /api/v2/search
    *
    * @param q The search query.
-   * @param type Enum of search target.
+   * @param options.type Enum of search target.
    * @param options.limit Maximum number of results to load, per type. Defaults to 20. Max 40.
    * @param options.max_id Return results older than this id.
    * @param options.min_id Return results immediately newer than this id.
@@ -2892,8 +2892,8 @@ export default class Pleroma implements MegalodonInterface {
    */
   public async search(
     q: string,
-    type: 'accounts' | 'hashtags' | 'statuses',
     options?: {
+      type?: 'accounts' | 'hashtags' | 'statuses'
       limit?: number
       max_id?: string
       min_id?: string
@@ -2905,10 +2905,14 @@ export default class Pleroma implements MegalodonInterface {
     }
   ): Promise<Response<Entity.Results>> {
     let params = {
-      q,
-      type
+      q
     }
     if (options) {
+      if (options.type) {
+        params = Object.assign(params, {
+          type: options.type
+        })
+      }
       if (options.limit) {
         params = Object.assign(params, {
           limit: options.limit