up to navigation
](#navigation)\n\n## API\n\n### Initializing\n\n```javascript\nconst jst = require('mobitel-json-schema-template');\n```\nReturns object for generating a JSON schema elements.\n[up to navigation
](#navigation)\n\n### .allOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.allOf(\n [\n { type: 'string' },\n { maxLength: 5 }\n ]\n);\n```\n\nResult\n```json\n{\n \"allOf\": [\n { \"type\": \"string\" },\n { \"maxLength\": 5 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n### .anyOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.anyOf(\n [\n {type: 'string'},\n jst.number().done()\n ]\n);\n```\n\nResult\n```json\n{\n \"anyOf\": [\n { \"type\": \"string\" },\n { \"type\": \"number\" }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n### .boolean([arg])\nArguments - `Boolean` or `'all'` (default)\n\n**Example Boolean**\n```javascript\njst.boolean(true);\n```\n\n**Result Boolean**\n```json\n{\n \"type\": \"boolean\",\n \"enum\": [true]\n}\n```\n\n**Example `'all'`**\n```javascript\njst.boolean();\n```\n\n**Result `'all'`**\n```json\n{\n \"type\": \"boolean\"\n}\n```\n[up to navigation
](#navigation)\n\n### .enum(arg[, arg2[, arg3]...])\nArguments - `Array|*`\nCan accept mix of `Array` and `*`\n\nExample\n```javascript\njst.enum(['one', 'two', 'three']);\n```\n\nResult\n```json\n{\n \"enum\": [\n \"one\",\n \"two\",\n \"three\"\n ]\n}\n```\n[up to navigation
](#navigation)\n\n### .not(arg)\nArguments - `Object`\n\nExample\n```javascript\njst.not({type: 'string'});\n```\n\nResult\n```json\n{\n \"not\": {\"type\": \"string\"}\n}\n```\n[up to navigation
](#navigation)\n\n### .null()\nArguments - no\n\nExample\n```javascript\njst.null();\n```\n\nResult\n```json\n{\n \"type\": \"null\"\n}\n```\n[up to navigation
](#navigation)\n\n### .oneOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.oneOf(\n [\n { type: 'number', multipleOf: 5 },\n jst.number().multipleOf(3).done()\n ]\n);\n```\n\nResult\n```json\n{\n \"oneOf\": [\n { \"type\": \"number\", \"multipleOf\": 5 },\n { \"type\": \"number\", \"multipleOf\": 3 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n### .ref(arg)\nArguments - `String`\n\nExample\n```javascript\njst.ref('#/definitions/subschema');\n```\n\nResult\n```json\n{\n \"$ref\": \"#/definitions/address\"\n}\n```\n[up to navigation
](#navigation)\n\n### .stringFormat(arg)\nArguments - `String`\nArgument must be values like:\n* date-time\n* email\n* hostname\n* ipv4\n* ipv6\n* uri\n\nExample\n```javascript\njst.stringFormat('hostname');\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"format\": \"hostname\"\n}\n```\n[up to navigation
](#navigation)\n\n\n\n\n\n### .array()\nArguments - no\n\nExample\n```javascript\njst.array().done();\n```\n\nResult\n```json\n{\n \"type\": \"array\"\n}\n```\n[up to navigation
](#navigation)\n\n#### .array().additional(arg)\nArguments - `Boolean`\n\nExample\n```javascript\njst.array().additional(true).done();\n```\n\nResult\n```json\n{\n \"type\": \"array\",\n \"additionalItems\": true\n}\n```\n[up to navigation
](#navigation)\n\n#### .array().items(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.array().items(\n [\n {type: 'string'},\n jst.number().done()\n ]\n).done();\n```\n\nResult\n```json\n{\n \"type\": \"array\",\n \"items\": [\n {\"type\": \"string\"},\n {\"type\": \"number\"}\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .array().max(arg)\nArguments - positive `Number`\n\nExample\n```javascript\njst.array().max(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"array\",\n \"maxItems\": 10\n}\n```\n[up to navigation
](#navigation)\n\n#### .array().min(arg)\nArguments - positive `Number`\n\nExample\n```javascript\njst.array().min(1).done();\n```\n\nResult\n```json\n{\n \"type\": \"array\",\n \"minItems\": 1\n}\n```\n[up to navigation
](#navigation)\n\n#### .array().unique()\nArguments - no\n\nExample\n```javascript\njst.array().unique().done();\n```\n\nResult\n```json\n{\n \"type\": \"array\",\n \"uniqueItems\": true\n}\n```\n[up to navigation
](#navigation)\n\n#### .array().done()\nArguments - no\nFinalize creation JSON schema template by type and return complete object.\n\nExample\n```javascript\njst.array().max(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"array\",\n \"maxItems\": 10\n}\n```\n[up to navigation
](#navigation)\n\n\n\n\n\n### .integer()\nArguments - no\n\nExample\n```javascript\njst.integer().done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\"\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().allOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.integer().allOf(\n [\n { type: 'integer' },\n { maximum: 5 }\n ]\n).done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"allOf\": [\n { \"type\": \"integer\" },\n { \"maximum\": 5 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().anyOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.integer().anyOf(\n [\n {type: 'integer', enum: [1, 5, 10]},\n jst.integer().min(10).done()\n ]\n).done();\n```\n\nResult\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"integer\",\n \"enum\": [1, 5, 10]\n },\n {\n \"type\": \"integer\",\n \"minimum\": 10\n }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().eMax()\nArguments - no\n\nExample\n```javascript\njst.integer().eMax().done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"exclusiveMaximum\": true\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().eMin()\nArguments - no\n\nExample\n```javascript\njst.integer().eMin().done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"exclusiveMinimum\": true\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().enum(arg[, arg2[, arg3]...])\nArguments - `Array|*`\nCan accept mix of `Array` and `*`\n\nExample\n```javascript\njst.integer().enum([1, 2, 3]).done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"enum\": [1, 2, 3]\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().max(arg)\nArguments - `Number` as integer\n\nExample\n```javascript\njst.integer().max(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"maximum\": 10\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().min(arg)\nArguments - `Number` as integer\n\nExample\n```javascript\njst.integer().min(1).done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"minimum\": 1\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().multipleOf(arg)\nArguments - positive `Number` as integer\n\nExample\n```javascript\njst.integer().multipleOf(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"multipleOf\": 10\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().not(arg)\nArguments - `Object`\n\nExample\n```javascript\njst.integer().not({enum: [1, 2, 3]}).done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"not\": {\n \"enum\": [1, 2, 3]\n }\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().oneOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.integer().oneOf(\n [\n { type: 'integer', maximum: 5 },\n jst.integer().max(3).done()\n ]\n).done();\n```\n\nResult\n```json\n{\n \"oneOf\": [\n { \"type\": \"integer\", \"maximum\": 5 },\n { \"type\": \"integer\", \"maximum\": 3 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .integer().done()\nArguments - no\nFinalize creation JSON schema template by type and return complete object.\n\nExample\n```javascript\njst.integer().max(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"integer\",\n \"maximum\": 10\n}\n```\n[up to navigation
](#navigation)\n\n\n\n\n\n### .number()\nArguments - no\n\nExample\n```javascript\njst.number().done();\n```\n\nResult\n```json\n{\n \"type\": \"number\"\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().allOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.number().allOf(\n [\n { type: 'number' },\n { maximum: 5 }\n ]\n).done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"allOf\": [\n { \"type\": \"number\" },\n { \"maximum\": 5 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().anyOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.number().anyOf(\n [\n {type: 'number', enum: [1, 5, 10]},\n jst.number().min(10).done()\n ]\n).done();\n```\n\nResult\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"number\",\n \"enum\": [1, 5, 10]\n },\n {\n \"type\": \"number\",\n \"minimum\": 10\n }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().eMax()\nArguments - no\n\nExample\n```javascript\njst.number().eMax().done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"exclusiveMaximum\": true\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().eMin()\nArguments - no\n\nExample\n```javascript\njst.number().eMin().done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"exclusiveMinimum\": true\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().enum(arg[, arg2[, arg3]...])\nArguments - `Array|*`\nCan accept mix of `Array` and `*`\n\nExample\n```javascript\njst.number().enum([1.5, 2.5, 3.5]).done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"enum\": [1.5, 2.5, 3.5]\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().max(arg)\nArguments - `Number`\n\nExample\n```javascript\njst.number().max(10.5).done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"maximum\": 10.5\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().min(arg)\nArguments - `Number`\n\nExample\n```javascript\njst.number().min(1.5).done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"minimum\": 1.5\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().multipleOf(arg)\nArguments - positive `Number` as integer\n\nExample\n```javascript\njst.number().multipleOf(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"multipleOf\": 10\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().not(arg)\nArguments - `Object`\n\nExample\n```javascript\njst.number().not({enum: [1.5, 2.5, 3.5]}).done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"not\": {\n \"enum\": [\n 1.5,\n 2.5,\n 3.5\n ]\n }\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().oneOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.number().oneOf(\n [\n { type: 'number', maximum: 5 },\n jst.number().max(3).done()\n ]\n).done();\n```\n\nResult\n```json\n{\n \"oneOf\": [\n { \"type\": \"number\", \"maximum\": 5 },\n { \"type\": \"number\", \"maximum\": 3 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .number().done()\nArguments - no\nFinalize creation JSON schema template by type and return complete object.\n\nExample\n```javascript\njst.number().max(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"number\",\n \"maximum\": 10\n}\n```\n[up to navigation
](#navigation)\n\n\n\n\n\n### .string()\nArguments - no\n\nExample\n```javascript\njst.string().done();\n```\n\nResult\n```json\n{\n \"type\": \"string\"\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().allOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.string().allOf(\n [\n { type: 'string' },\n { maxLength: 5 }\n ]\n).done();\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"allOf\": [\n { \"type\": \"string\" },\n { \"maxLength\": 5 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().anyOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.string().anyOf(\n [\n {type: 'string', pattern: \"^\\\\d+$\"},\n jst.string().min(10).done()\n ]\n).done();\n```\n\nResult\n```json\n{\n \"anyOf\": [\n {\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\"\n },\n {\n \"type\": \"string\",\n \"minLength\": 10\n }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().enum(arg[, arg2[, arg3]...])\nArguments - `Array|*`\nCan accept mix of `Array` and `*`\n\nExample\n```javascript\njst.string().enum(['one', 'two', 'three']).done();\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"enum\": [\n \"one\",\n \"two\",\n \"three\"\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().max(arg)\nArguments - positive `Number` as integer\n\nExample\n```javascript\njst.string().max(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"maxLength\": 10\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().min(arg)\nArguments - positive `Number` as integer\n\nExample\n```javascript\njst.string().min(1).done();\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"minLength\": 1\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().not(arg)\nArguments - `Object`\n\nExample\n```javascript\njst.string().not({enum: ['one', 'two', 'three']}).done();\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"not\": {\n \"enum\": [\n \"one\",\n \"two\",\n \"three\"\n ]\n }\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().oneOf(arg[, arg2[, arg3]...])\nArguments - `Object[]|Object`\nCan accept mix of `Object[]` and `Object`\n\nExample\n```javascript\njst.string().oneOf(\n [\n { type: 'string', maxLength: 5 },\n jst.string().max(3).done()\n ]\n).done();\n```\n\nResult\n```json\n{\n \"oneOf\": [\n { \"type\": \"string\", \"maxLength\": 5 },\n { \"type\": \"string\", \"maxLength\": 3 }\n ]\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().pattern(arg)\nArguments - `RegExp|String`\n\nExample\n```javascript\njst.string().pattern(\"^\\\\d+$\").done();\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"pattern\": \"^\\\\d+$\"\n}\n```\n[up to navigation
](#navigation)\n\n#### .string().done()\nArguments - no\nFinalize creation JSON schema template by type and return complete object.\n\nExample\n```javascript\njst.string().max(10).done();\n```\n\nResult\n```json\n{\n \"type\": \"string\",\n \"maxLength\": 10\n}\n```\n[up to navigation
](#navigation)\n\n\n## Testing\n\n npm run test\n[up to navigation
](#navigation)\n\n\n## License\nMIT License.\nCopyright (c) 2017 Mobitel Ltd\n[up to navigation
](#navigation)\n\n","maintainers":[{"name":"mobitel-ltd","email":"pragmawolf@gmail.com"}],"time":{"modified":"2022-05-09T13:54:27.608Z","created":"2017-08-22T15:40:12.737Z","1.0.0":"2017-08-22T15:40:12.737Z","1.0.1":"2017-08-24T15:59:47.416Z","1.0.2":"2017-09-05T11:06:27.198Z","1.0.3":"2017-10-13T22:09:40.567Z"},"homepage":"https://github.com/mobitel-ltd/mobitel-json-schema-template#readme","keywords":["json","schema","template","simple","create","mobitel"],"repository":{"type":"git","url":"git+https://github.com/mobitel-ltd/mobitel-json-schema-template.git"},"author":{"name":"Dmitry Furman aka PragmaWolf, Mobitel Ltd","email":"pragmawolf@gmail.com"},"bugs":{"url":"https://github.com/mobitel-ltd/mobitel-json-schema-template/issues"},"license":"MIT","readmeFilename":"README.md"}