odata-fluent-query

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #golang #machine-learning #deep-learning #linux #windows #awesome #kubernetes #awesome-list #vue #security #ios

odata-fluent-query

(★ 44)

odata query builder

odata-fluent-query 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# odata-fluent-query

> **A modern, type-safe OData query builder for TypeScript**

![npm version](https://badge.fury.io/js/odata-fluent-query.svg)
![TypeScript](https://img.shields.io/badge/TypeScript-5.6+-blue)
![Node](https://img.shields.io/badge/Node-18+-green)
![Coverage](https://img.shields.io/badge/Coverage-100%25-brightgreen)

✨ **Version 3.0** - Fully modernized and production-ready

**Client side queries with extensive filtering and typesafe joins**

> **Note:** This library only generates the OData query string. You are responsible for sending the HTTP request using your preferred method or library.

## Features

- 🎯 **Full TypeScript support** with built-in type definitions
- 🔒 **Type-safe queries** with IntelliSense support
- 🚀 **Modern ES2022** target for optimal performance
- ✅ **100% test coverage** with 389 comprehensive tests
- 📦 **Minimal dependencies** with only uuid as a runtime dependency
- 🔧 **Fluent API** for readable query building
- 🔄 **Parse existing query strings** with `fromString()` method

## Installation

```bash
npm install odata-fluent-query
```

**Requirements:**

- Node.js 18+
- TypeScript 5.0+ (optional, but recommended)

## TypeScript Support

This package includes built-in TypeScript definitions and provides full type safety:

```ts
interface User {
  id: number
  email: string
  isActive: boolean
  posts?: Post[]
}

// Full intellisense and type checking
const query = odataQuery<User>()
  .filter(u => u.email.contains('test'))  // ✅ Type-safe
  .select('id', 'email')                  // ✅ Only valid properties
  .orderBy(u => u.isActive)               // ✅ Correct types
  .toString()

// Result: "$filter=contains(email,'test')&$select=id,email&$orderby=isActive"
```

### Full Example

```ts
import { odataQuery } from 'odata-fluent-query'

// Simple filter
const query = odataQuery<User>()
  .filter(u => u.id.equals(1))
  .toString()
// Result: $filter=id eq 1

// Complex query with multiple operations
const complexQuery = odataQuery<User>()
  .select('id', 'email', 'username')
  .filter(u => u.isActive.equals(true).and(u.email.contains('@company.com')))
  .orderBy(u => u.username)
  .paginate(10, 0)
  .toString()
```

### Query Result Type Inference

Get the TypeScript type for what your OData query will return using `typeof query.type`:

```ts
function getActiveUsers() {
  // Basic select operation
  const query = odataQuery<User>().select('id', 'email')
  type UserResponse = typeof query.type // Will be Pick<User, 'id' | 'email'>

// Use in HTTP requests
  return http.get<UserResponse[]>(`/Users?${query.toString()}`)
}
```

## Documentation

### Core Features

- **[Filtering](docs/filtering.md)** - Advanced filtering with type-safe expressions
- **[Selecting](docs/selecting.md)** - Choose specific properties to return
- **[Ordering](docs/ordering.md)** - Sort results with complex ordering rules
- **[Expanding](docs/expanding.md)** - Include related data with nested queries
- **[Computing](docs/computing.md)** - Create computed properties with type safety
- **[Type Inference](docs/type-inference.md)** - Get TypeScript types for query results
- **[Searching](docs/searching.md)** - Full-text search with automatic quoting
- **[Grouping](docs/grouping.md)** - Group data with aggregations
- **[Pagination](docs/pagination.md)** - Handle large datasets with pagination
- **[Parsing](docs/parsing.md)** - Parse existing query strings back to objects

## Development

**Requirements:**

- Node.js 18+
- npm 8+

**Setup:**

```bash
npm install
```

**Build:**

```bash
npm run build        # Build the project
npm run build:watch  # Build in watch mode
```

**Testing:**

```bash
npm test                # Run tests
npm run test:coverage   # Run with coverage report
npm run test:watch      # Run tests in watch mode
npm run test:debug      # Debug tests
```

**Code Quality:**

This project uses [Biome](https://biomejs.dev/) for linting and formatting.

```bash
npm run format         # Format code with Biome
npm run lint           # Check code style with Biome
npm run lint:fix       # Auto-fix linting issues with Biome
npm run check          # Run both format and lint with Biome
npm run ci             # Full CI check (build + test + coverage)
```

**Publishing:**

```bash
npm run ci             # Verify everything works
npm publish            # Publish to npm (runs CI automatically)
```

The output files will be placed in the `dist` directory. This project contains comprehensive unit tests using `jest` and `ts-jest`.

After running tests with coverage, you can open `coverage/lcov-report/index.html` in your browser to see detailed coverage reports.

## Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Run tests (`npm run ci`)
4. Commit your changes (`git commit -m 'Add some amazing feature'`)
5. Push to the branch (`git push origin feature/amazing-feature`)
6. Open a Pull Request

## License

MIT - see [LICENSE](LICENSE) file for details.

odata-fluent-query

odata-fluent-query 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

odata-fluent-query

odata-fluent-query 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README