---
sidebar_label: "Overview"
title: "API Reference - CyberGo JSON | Complete Function Reference"
description: "CyberGo JSON API reference: GetString/GetInt queries, Set/Delete, Marshal/Unmarshal, Processor, Schema validation, Hook, and security config."
sidebar_position: 1
---

# API Reference

This section provides the complete API reference for the `github.com/cybergodev/json` library.

## Module Index

| Module | Description |
|--------|-------------|
| [Package Functions](./functions/) | Package-level function reference, including path queries, type getters, encoding/decoding, etc. |
| [Processor](./processor/) | Processor methods and configuration |
| [Config](./config) | Configuration options in detail |
| [Type Definitions](./types) | Core type definitions (including Encoder/Decoder) |
| [Generic Operations](./generics) | Generic API reference |
| [Interface Definitions](./interfaces) | Extension interface definitions |
| [Stream Processing](../streaming/large-files) | Stream processor reference |
| [NDJSON Processing](../streaming/jsonl) | JSONL/NDJSON processor |
| [Iterator](./iterator) | Iteration traversal API |
| [Helper Functions](./helpers) | Type conversion and utility functions |
| [Pretty Print](./print) | Formatting and pretty-print output |
| [Security](../security/security-mode) | Security-related API |
| [Validator](../extensions/validator) | Schema validator |
| [Hook System](../extensions/hooks) | Operation interception hooks |
| [Custom Encoder](../extensions/custom-encoder) | Custom encoders |
| [Constants & Errors](./constants) | Constants and error types |

## Quick Find

### By Feature Category

#### Path Queries

| Function | Description |
|----------|-------------|
| `Get`, `GetWithContext`, `GetString`, `GetInt`, `GetFloat`, `GetBool`, `GetArray`, `GetObject` | Type-safe getters |
| `GetTyped[T]` | Generic getter |
| `SafeGet` | Safe getter returning AccessResult |
| `GetMultiple` | Batch getter |

#### Modify Operations

| Function | Description |
|----------|-------------|
| `Set`, `SetMultiple` | Set values |
| `SetCreate`, `SetMultipleCreate` | Set values with automatic path creation |
| `Delete`, `DeleteClean` | Delete values |
| `ProcessBatch` | Batch operations |

#### Encoding & Decoding

| Function | Description |
|----------|-------------|
| `Marshal`, `Unmarshal` | Standard encoding/decoding (compatible with `encoding/json`, optional `cfg`) |
| `MarshalIndent` | Pretty-print encoding (compatible with `encoding/json.MarshalIndent`, optional `cfg`) |
| `Encode`, `EncodeWithConfig` | Encode to string |
| `NewEncoder`, `NewDecoder` | Stream encoding/decoding |
| `Parse` | Parse JSON |

#### Formatting

| Function | Description |
|----------|-------------|
| `Prettify` | Format JSON |
| `Compact` | Compact JSON (buffer form, compatible with `encoding/json.Compact`) |
| `CompactString` | Compact JSON (string in/out form, mirrors `Processor.Compact`) |

#### File Operations

| Function | Description |
|----------|-------------|
| `LoadFromFile`, `SaveToFile` | File read/write |
| `LoadFromReader` | Read from Reader |
| `MarshalToFile`, `UnmarshalFromFile` | File encoding/decoding |

#### Stream Processing

| Type/Method | Description |
|-------------|-------------|
| `StreamLinesInto[T]` | Stream read JSONL from Reader and convert to `[]T` |
| `ParseJSONL` | Parse JSONL bytes to `[]any` |
| `ToJSONL`, `ToJSONLString` | Convert `[]any` to JSONL format |
| `JSONLWriter` | JSONL writer (Write/WriteAll/WriteRaw) |
| `NDJSONProcessor` | NDJSON/JSONL processor |
| `ForeachFile` | File stream processing |

#### Validation

| Function | Description |
|----------|-------------|
| `Valid` | JSON validation (compatible with `encoding/json.Valid`) |
| `ValidWithConfig` | JSON validation with configuration |
| `ValidateSchema` | Schema validation (used with `Schema` type) |
| `CompareJSON` | Compare JSON for equivalence |

## Naming Conventions

The library follows these naming conventions:

| Pattern | Description | Example |
|---------|-------------|---------|
| `Get{Type}` | Get specified type (supports defaultValue) | `GetString`, `GetInt` |
| `GetTyped[T]` | Generic getter, returns T | `GetTyped[User]` |
| `New{Type}` | Create instance | `New` (returns *Processor), `NewEncoder` |
| `Default{Type}` | Default configuration | `DefaultConfig` |
| `{Type}Config` | Configuration preset | `SecurityConfig`, `PrettyConfig` |

## Related

- [Getting Started](../getting-started/) -- Installation and basic usage
- [Path Expression Syntax](../getting-started/path-syntax) -- Path query syntax
- [Usage Examples](../examples/) -- Practical code examples
- [Large File Processing](../streaming/large-files) -- Stream processing guide