Download the PHP package sirmekus/nkem without Composer

On this page you can find all versions of the php package sirmekus/nkem. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package nkem

About Nkem

This is a CLI package that replaces values in a JSON file to their types in either Typescript or JSON.

If you work on developing API, you'll agree that it's important to have a good understanding of the data that's being sent to and from the API/server. This package aims to make that process easier by generating valid "types" for your JSON response(s) via feeding it with a sample of an actual response (stored in a JSON file).

You can also, of course, use it to generate valid type interface for your TypeScript code.

By the way, "Nkem" is a word that means "my own" in Igbo language.😉

Installation

To install the package, run:

How To Use

After installing the package, run it in your terminal like so:

If you want its TypeScript representation, run it like so:

By default, the generated file will retain the name of the supplied JSON file with "-type" appended to it. You can change this behavior by using the --name flag. For example, if you want to name the generated file "custom-name.ts", you can run it like so (without the extension):

Limitations

The types will be generated based on the values in the JSON file.

Also, if a key can contain a range of possible types (like "string|number"), the package may not be able to interpret it correctly. For example, if the JSON file contains a key whose value can either be a string or an number but the value in the JSON file is a string, its type will be generated as string.

To rectify this limitation, manual interaction may be required for the affected keys after generating the types.

Primarily, the package does the heavy lifting of generating the types for you.

Contributing

Of course, there can always be room (and parlour 😁) for improvement. If you have any suggestions or ideas, please feel free to open an issue or submit a pull request.

License

This package is licensed under the MIT License.

All versions of nkem with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sirmekus/nkem contains the following files

Loading the files please wait ...