# js-to-java

> easy way to wrap js object to java object

Latest version **2.8.0** (published 2023-07-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install js-to-java
pnpm add js-to-java
yarn add js-to-java
bun add js-to-java
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.8.0 |
| Published | 2023-07-11 |
| First published | 2014-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/js-to-java) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 201 |
| Author | dead_horse |
| Maintainers | gxcsoccer, dead_horse, coolme200, fengmk2 |
| Keywords | js, java, object, class |

## Links

- npm: https://www.npmjs.com/package/js-to-java
- Repository: https://github.com/node-modules/js-to-java
- Issues: https://github.com/node-modules/js-to-java/issues
- npm.io page: https://npm.io/package/js-to-java

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 2.8.0 (latest) — 2023-07-11
- 2.7.0 — 2021-04-25
- 2.6.1 — 2019-01-30
- 2.6.0 — 2018-06-01
- 2.5.0 — 2018-02-27
- 2.4.0 — 2016-06-06
- 2.3.5 — 2016-03-30
- 2.3.4 — 2016-03-09
- 2.3.3 — 2016-01-08
- 2.3.2 — 2015-12-23
- 2.3.1 — 2015-11-27
- 2.3.0 — 2015-11-09
- 2.2.0 — 2015-10-21
- 2.1.1 — 2015-09-07
- 2.0.7 — 2015-07-06
- … 12 more at https://npm.io/package/js-to-java/versions

## README

js-to-java
==========

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][cov-image]][cov-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/js-to-java.svg?style=flat-square
[npm-url]: https://npmjs.org/package/js-to-java
[travis-image]: https://img.shields.io/travis/node-modules/js-to-java.svg?style=flat-square
[travis-url]: https://travis-ci.org/node-modules/js-to-java
[cov-image]: http://codecov.io/github/node-modules/js-to-java/coverage.svg?branch=master
[cov-url]: http://codecov.io/github/node-modules/js-to-java?branch=master
[download-image]: https://img.shields.io/npm/dm/js-to-java.svg?style=flat-square
[download-url]: https://npmjs.org/package/js-to-java

Easy way to wrap js object to java object.

In [hessian.js](https://github.com/node-modules/hessian.js), we need to write java classname with js object so make it encode as the write class.

## Install

[![NPM](https://nodei.co/npm/js-to-java.png?downloads=true)](https://nodei.co/npm/js-to-java/)

```bash
$ npm install js-to-java
```

## Usage

### Example

```js
var java = require('js-to-java');

// Java: com.java.Object o = new com.java.Object();
java('com.java.Object', { foo: 'bar' });
// => {$class: 'com.java.Object', $: { foo: 'bar' }}

// Java: Boolean r;
java.Boolean(true);
// => {$class: 'java.lang.Boolean', $: true}

// Java: short[] shorts = new short[] {1, 2, 3};
java.array('short', [1, 2, 3]);
// => {$class: '[short', $: [1, 2, 3]}

// Java: int[] ints = new int[] {1, 2, 3};
java.array('int', [1, 2, 3]);
// same to the next example
java.array.int([1, 2, 3]);
// => {$class: '[int', $: [1, 2, 3]}
```

## API

### Type Mapping

```js
  Boolean: 'java.lang.Boolean',
  boolean: 'boolean',
  Integer: 'java.lang.Integer',
  int: 'int',
  short: 'short',
  Short: 'java.lang.Short',
  byte: 'byte',
  Byte: 'java.lang.Byte',
  long: 'long',
  Long: 'java.lang.Long',
  double: 'double',
  Double: 'java.lang.Double',
  float: 'float',
  Float: 'java.lang.Float',
  String: 'java.lang.String',
  char: 'char',
  chars: 'char[]',
  Character: 'java.lang.Character',
  List: 'java.util.List',
  Set: 'java.util.Set',
  Collection: 'java.util.Collection',
  Iterator: 'java.util.Iterator',
  Enumeration: 'java.util.Enumeration',
  HashMap: 'java.util.HashMap',
  Map: 'java.util.Map',
  Dictionary: 'java.util.Dictionary'
```

### java.abstract(abstractClassname, classname, value)

abstract class

```js
java.abstract('com.demo.Parent', 'com.demo.Child', { foo: 'bar' });
// => { $abstractClass: 'com.demo.Parent', $class: 'com.demo.Child', $: { foo: 'bar' } }
```

### java[.combine](classname, value)

Custom combineFunction:

```js
java.combine('com.test.Object', { foo: 'bar' });
java('com.test.Object', { foo: 'bar' });
// => { $class: 'com.test.Object', $: { foo: 'bar' } }
```

### java.Class(classname)

```js
java.Class('java.lang.String');
// => { $class: 'java.lang.Class', $: { name: 'java.lang.String' } }
```

### java.Locale(locale, handle)

```js
java.Locale('zh_CN', ['com.caucho.hessian.io.LocaleHandle']);
// => { $class: 'com.caucho.hessian.io.LocaleHandle', $: { value: 'zh_CN' } }
```

### java.BigDecimal(decimal)

```js
java.BigDecimal('100.06');
// Or java.BigDecimal({value: '100.06'});
// => { $class: 'java.math.BigDecimal', $: { value: '100.06' } }
```

### java.enum(classname, value)

```js
java.enum('hessian.demo.Color', 'RED');
  or
java.enum('hessian.demo.Color', {name: 'RED'});
// => { $class: 'hessian.demo.Color', $: { name: 'RED' } }
```

### java.array(classname, values)

```js
java.array('Boolean', [true, false]);
// => { $class: '[java.lang.Boolean' $: [true, false] }
```

Available built-in classes shortcuts:

- `java.array.Boolean(values)`
- `java.array.boolean(values)`
- `java.array.Integer(values)`
- `java.array.int(values)`
- `java.array.short(values)`
- `java.array.Short(values)`
- `java.array.byte(values)`
- `java.array.Byte(values)`
- `java.array.long(values)`
- `java.array.Long(values)`
- `java.array.double(values)`
- `java.array.Double(values)`
- `java.array.float(values)`
- `java.array.Float(values)`
- `java.array.String(values)`
- `java.array.char(values)`
- `java.array.chars(values)`
- `java.array.Character(values)`
- `java.array.List(values)`
- `java.array.Set(values)`
- `java.array.Iterator(values)`
- `java.array.Enumeration(values)`
- `java.array.HashMap(values)`
- `java.array.Map(values)`
- `java.array.Dictionary(values)`

### java.exception(err[, className])

default className is `java.lang.Exception`.

```js
{
  '$class': `${className}`,
  '$': {
    detailMessage: {
      '$class': 'java.lang.String',
      '$': `${err.name}: ${err.message}`,
    },
    stackTrace: {
      '$class': '[java.lang.StackTraceElement',
      '$': stackTraceElements,
    },
  },
}
```

### java.revert(obj)

Wrap java object back to js object reversely.

```js
var data = {
  $class: 'xxxx',
  $: {
    foo: 'bar',
    bar: {
      $class: 'int',
      $: 3,
    },
  },
};
java.revert(data);
// => {foo: 'bar', bar: 3}
```

## License

MIT

---
_Source: https://npm.io/package/js-to-java · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._