Skip to content

Cleaned up errors to be more precise. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 26, 2019
Merged

Cleaned up errors to be more precise. #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5d0899
Cleaned up errors to be more precise.
Andrew-Cha Mar 26, 2019
630ab9f
Small edits to above
kaimoe Mar 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions XIVAPI.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class XIVAPI {
*/
constructor(apikey, options = {}) {
if(typeof(apikey) === 'undefined')
throw Error('apikey must be defined')
throw Error('The apikey must be defined.')

this.endpoint = `https://${options.staging ? 'staging.' : ''}xivapi.com`
this.globalParams = {
Expand All @@ -27,7 +27,7 @@ class XIVAPI {
snake_case: options.snake_case
}
if(!resources.languages.includes(this.globalParams.language))
throw Error(`invalid language given, must be: ${this.resources.languages}`)
throw Error(`Invalid language given, must be: ${this.resources.languages}`)

this.resources = resources

Expand Down
10 changes: 5 additions & 5 deletions lib/character.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ class Character extends Lib {
search(name, params = {}) {
return new Promise((resolve, reject) => {
if(!name)
reject(Error('name must be defined'))
reject(Error('The name must be defined for Character searching.'))
if(params.server && !this.parent.resources.servers.includes(firstCapital(params.server)))
reject(Error('server not valid'))
reject(Error('The server is not valid for Character searching.'))

this.req(
'/character/search',
Expand All @@ -41,7 +41,7 @@ class Character extends Lib {
get(id, params = {}) {
return new Promise((resolve, reject) => {
if(!id)
reject(Error('id must be defined'))
reject(Error('The id must be defined for get() in Character.'))

params.extended = params.extended ? 1 : 0

Expand All @@ -63,7 +63,7 @@ class Character extends Lib {
verification(id, token) {
return new Promise((resolve, reject) => {
if(!id)
reject(Error('id must be defined'))
reject(Error('The id must be defined for Character verification.'))

this.req(
`/character/${id}/verification`,
Expand All @@ -82,7 +82,7 @@ class Character extends Lib {
update(id) {
return new Promise((resolve, reject) => {
if(!id)
reject(Error('id must be defined'))
reject(Error('The id must be defined for Character update.'))

this.req(`/character/${id}update`).then((res) => {
resolve(res === 1)
Expand Down
8 changes: 4 additions & 4 deletions lib/data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class Content extends Lib {
list(name, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(name) === 'undefined')
reject(Error('name must be defined'))
reject(Error('The name must be defined for Content list.'))

params.ids = makeCSV(params.ids)

Expand All @@ -46,7 +46,7 @@ class Content extends Lib {
schema(name) {
return new Promise((resolve, reject) => {
if(typeof(name) === 'undefined')
reject(Error('name must be defined'))
reject(Error('The name must be defined for Content schema.'))

this.req(`/${name}/schema`).then((res) => {
resolve(res)
Expand All @@ -59,9 +59,9 @@ class Content extends Lib {
get(name, id) {
return new Promise((resolve, reject) => {
if(typeof(name) === 'undefined')
reject(Error('name must be defined'))
reject(Error('The name must be defined for get() in Content.'))
if(typeof(id) === 'undefined')
reject(Error('id must be defined'))
reject(Error('The id must be defined for get() in Content.'))

this.req(`/${name}/${id}`).then((res) => {
resolve(cleanContent(res))
Expand Down
6 changes: 3 additions & 3 deletions lib/freecompany.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ class FreeCompany extends Lib {
search(name, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(name) === 'undefined')
reject(Error('name must be defined'))
reject(Error('The name must be defined for FreeCompany search.'))
if(params.server && !this.parent.resources.servers.includes(firstCapital(params.server)))
reject(Error('server not valid'))
reject(Error('The server is not valid for FreeCompany search.'))

this.req(
'/freecompany/search',
Expand Down Expand Up @@ -48,7 +48,7 @@ class FreeCompany extends Lib {
get(id, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(id) === 'undefined')
reject(Error('id must be defined'))
reject(Error('The id must be defined for get() in FreeCompany.'))

id = sanitizeInt(id)
params.data = makeCSV(params.data)
Expand Down
6 changes: 3 additions & 3 deletions lib/linkshell.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ class Linkshell extends Lib {
search(name, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(name) === 'undefined')
reject(Error('name must be defined'))
reject(Error('The name must be defined for Linkshell search.'))

if(params.server && !this.parent.resources.servers.includes(firstCapital(params.server)))
reject(Error('server not valid'))
reject(Error('The server is not valid for Linkshell search.'))

this.req(
'/linkshell/search',
Expand All @@ -43,7 +43,7 @@ class Linkshell extends Lib {
get(id) {
return new Promise((resolve, reject) => {
if(typeof(id) === 'undefined')
reject(Error('id must be defined'))
reject(Error('The id must be defined for get() in Linkshell.'))
id = sanitizeInt(id)

this.req('/linkshell/' + id).then((res) => {
Expand Down
18 changes: 9 additions & 9 deletions lib/market.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ class Content extends Lib {
prices(id, server, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(id) === 'undefined')
reject(Error('id must be defined'))
reject(Error('The id must be defined for market prices.'))
if(typeof(server) === 'undefined')
reject(Error('server must be defined'))
reject(Error('The server must be defined for market prices.'))
if(!this.parent.resources.servers.includes(firstCapital(server)))
reject(Error('server not valid'))
reject(Error('The server is not valid for market prices.'))

this.req(
`/market/${server}/items/${id}`,
Expand All @@ -41,11 +41,11 @@ class Content extends Lib {
history(id, server, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(id) === 'undefined')
reject(Error('id must be defined'))
reject(Error('The id must be defined for market history.'))
if(typeof(server) === 'undefined')
reject(Error('server must be defined'))
reject(Error('The server must be defined for market history.'))
if(!this.parent.resources.servers.includes(firstCapital(server)))
reject(Error('server not valid'))
reject(Error('The server is not valid for market history.'))


this.req(
Expand All @@ -71,11 +71,11 @@ class Content extends Lib {
stock(category, server, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(category) === 'undefined')
reject(Error('category must be defined'))
reject(Error('The category must be defined for market stock.'))
if(typeof(server) === 'undefined')
reject(Error('server must be defined'))
reject(Error('The server must be defined for market stock.'))
if(!this.parent.resources.servers.includes(firstCapital(server)))
reject(Error('server not valid'))
reject(Error('The server is not valid for market stock.'))

this.req(
`/market/${server}/category/${category}`,
Expand Down
6 changes: 3 additions & 3 deletions lib/pvpteam.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ class PvPTeam extends Lib {
search(name, params = {}) {
return new Promise((resolve, reject) => {
if(typeof(name) === 'undefined')
reject(Error('name must be defined'))
reject(Error('The name for PvPTeam must be defined.'))

if(params.server && !this.parent.resources.servers.includes(firstCapital(params.server)))
reject(Error('server not valid'))
reject(Error('The server for PvPTeam is not valid.'))

this.req(
'/pvpteam/search',
Expand All @@ -42,7 +42,7 @@ class PvPTeam extends Lib {
get(id) {
return new Promise((resolve, reject) => {
if(typeof(id) === 'undefined')
reject(Error('id must be defined'))
reject(Error('The id for PvPTeam must be defined.'))
id = sanitizeInt(id)

this.req('/pvpteam/' + id).then((res) => {
Expand Down
4 changes: 2 additions & 2 deletions lib/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ module.exports = function(input, params = {}) {

return new Promise((resolve, reject) => {
if(typeof(input) === 'undefined')
reject(Error('input must be defined'))
reject(Error('The input must be defined for searching.'))

let path = params.lore ? '/lore' : '/search'

Expand Down Expand Up @@ -57,7 +57,7 @@ module.exports = function(input, params = {}) {
break

default:
reject(Error(`unexpected input type '${typeof(input)}'`))
reject(Error(`Unexpected input type for search: '${typeof(input)}'`))
break
}
})
Expand Down