@qnx/client NPM

@qnx/client

@qnx/client is providing components to simplify your codes.

Installation

Use the package manager npm to install @qnx/client.

npm install @qnx/client

You can also use yarn & pnpm

yarn add @qnx/client

pnpm install @qnx/client

Usage

import { ApiResponse } from '@qnx/client'

const res = {
  data: 10,
  errorCode: 'ERR002',
  error: 'An error occurred',
  errors: {
    field1: ['Error message 1', 'Error message 2'],
    field2: ['Error message 3']
  },
  message: 'Request successful.',
  serverError: {
    code: 500,
    message: 'Internal server error'
  }
}

const apiRes = ApiResponse(res)

const data = apiRes.getData()
const message = apiRes.getMessage()
const errors = apiRes.getErrors()
const error = apiRes.getError()
const errorCode = apiRes.getErrorCode()

import { ApiSuccessResponse } from '@qnx/client'

const res = {
  data: 10,
  message: 'Request successful.'
}

const apiRes = ApiSuccessResponse(res)

const data = apiRes.getData()
const message = apiRes.getMessage()

import { ApiErrorResponse } from '@qnx/client'

const res = {
  errorCode: 'ERR002',
  error: 'An error occurred',
  errors: {
    field1: ['Error message 1', 'Error message 2'],
    field2: ['Error message 3']
  }
}

const apiRes = ApiErrorResponse(res)

const errors = apiRes.getErrors()
const error = apiRes.getError()
const errorCode = apiRes.getErrorCode()

// ApiResponseValue
import type { ApiResponseValue } from '@qnx/client'

const response: ApiResponseValue<number> = {
  data: 10,
  errorCode: 'ERR002',
  error: 'An error occurred',
  errors: {
    field1: ['Error message 1', 'Error message 2'],
    field2: ['Error message 3']
  },
  message: 'Request successful.',
  serverError: {
    code: 500,
    message: 'Internal server error'
  }
}

// ApiResponseValue
import type { ApiSuccessResponseValue } from '@qnx/client'

const successResponse: ApiSuccessResponseValue<number> = {
  data: 10,
  message: 'Request successful.'
}

// ApiErrorResponseValue
import type { ApiErrorResponseValue } from '@qnx/client'

const errorResponse: ApiErrorResponseValue = {
  errors: {
    field1: ['Error message 1', 'Error message 2'],
    field2: ['Error message 3']
  },
  error: 'An error occurred',
  errorCode: 'ERR002'
}