aboutsummaryrefslogtreecommitdiff
path: root/content/docs/mal2go/v4/manga/search-for-a-manga.md
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@vidhukant.xyz>2022-09-20 23:11:52 +0530
committerVidhu Kant Sharma <vidhukant@vidhukant.xyz>2022-09-20 23:11:52 +0530
commitf23dae307e06d95499b35dbdd8e341b45756b330 (patch)
treeb46c707a8cd62f8c63c78eb4018dc9bc0da1cffe /content/docs/mal2go/v4/manga/search-for-a-manga.md
First commit
Diffstat (limited to 'content/docs/mal2go/v4/manga/search-for-a-manga.md')
-rw-r--r--content/docs/mal2go/v4/manga/search-for-a-manga.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/content/docs/mal2go/v4/manga/search-for-a-manga.md b/content/docs/mal2go/v4/manga/search-for-a-manga.md
new file mode 100644
index 0000000..5d519aa
--- /dev/null
+++ b/content/docs/mal2go/v4/manga/search-for-a-manga.md
@@ -0,0 +1,51 @@
+---
+title: "Search for a manga"
+description: "Use a search string to get a list of mangas"
+weight: 2
+---
+
+Use the `SearchManga` method to search for a manga. This method takes these arguments:
+
+- `searchString string` Is pretty obvious. This term is used to search for a manga on MyAnimeList.
+- `limit int` Is the max amount of search results to get. Max is 100.
+- `offset int` Is the "offset" for the search results. If offset is greater than 0 the first n number of search reults will be ignored.
+- `nsfw bool` Wether to include NSFW rated search results
+- `fields []string` The fields to include in the search results. [Here]() is a list of the valid fields. Just using an empty slice (`[]string{}`) will include all the fields.
+The MyAnimeList API is picky about what fields to actually include with search results. To be sure that you are getting all the data it is recommended to use the [`GetMangaById`](#get-data-about-a-manga) method which ensures that all the required fields are included.
+
+
+Example:
+
+``` go
+package main
+
+import (
+ "github.com/MikunoNaka/MAL2Go/v4/manga"
+ "log"
+ "fmt"
+)
+
+func main() {
+ authToken := "YOUR_TOKEN_HERE"
+ myClient := manga.Client {
+ AuthToken: "Bearer " + authToken,
+ }
+
+ searchString := "mushishi" // search for mushishi
+ limit := 10 // get 10 search results
+ offset := 0 // no offset
+ searchNsfw := false // don't include NSFW results
+ fields := []string{"title"} // only pull the title
+
+ searchResults, err := myClient.SearchManga(searchString, limit, offset, searchNsfw, fields)
+ if err != nil {
+ log.Fatal(err) // remember kids, always handle errors
+ }
+
+ // loop over the search results and print the title
+ for _, manga := range searchResults {
+ fmt.Println(manga.Title)
+ }
+}
+```
+