nextemos

nextemos, PROJE INC. projeleri için TypeScript type ve interface'leri, API'lerle iletişim kurmak için bir servis katmanı ve genel helper ve hook'ları içeren özel bir NPM paketidir. Bu paket, projelerinizde kodunuzu daha modüler ve yeniden kullanılabilir hale getirmeyi amaçlar.

Kurulum

nextemos paketini projenize eklemek için aşağıdaki komutu kullanabilirsiniz:

npm  install  nextemos

veya

yarn add nextemos

Kullanım

Type ve Interface'ler

nextemos paketi, projelerinizde kullanabileceğiniz çeşitli TypeScript type ve interface'leri sağlar. Bu type ve interface'ler, kodunuzun daha tip güvenli ve okunabilir olmasını sağlar.

Servis Katmanı

API'lerle iletişim kurmak için bir servis katmanı içerir. Bu katman, API isteklerinizi yönetir ve tekrar eden kodları ortadan kaldırarak daha temiz bir yapı sağlar. Örneğin:

...
import { Service } from 'nextemos';

// server component (async)
export  default  async  function  Home() {
	
	// istekler async-await olarak yapılmalıdır
	const { data, status, error } =  await  Service.Banner.GetBannerList(
		{ bannerKeys:  ["slider"] },
		{ cache: 'force-cache' } // opsiyonel
	);

	if (status !== 200) return;

	return  <SliderComponent  data={data}  />;
}

Helper ve Hook'lar

nextemos paketi, genel helper ve hook'lar da içerir. Bu helper ve hook'lar, projelerinizde sıkça karşılaşılan görevleri basitleştirir. Örneğin:

...
import { useFetch } from 'nextemos';

export default function ProductList() {
	const { response, loading, error } = useFetch({
		url: '/tr/api/product/getProductList'
	});
}

Environment Değişkenleri

nextemos paketi, belirli environment değişkenlerini kullanır. Bu değişkenler, paketinizin yapılandırmasını ve çalışma şeklini etkiler:

• API_URL: API isteklerinizin yapılacağı temel URL'yi belirtir. Bu, projenizin hangi sunucuya istek göndereceğini belirler.
• DEFAULT_LANGUAGE: Uygulamanızın varsayılan dilini belirler. Çok dilli projelerde kullanışlıdır. API isteklerinde dil parametresi gönderilmezse bu değer varsayılan kabul edilecektir.
• USE_API_URL: API_URLnin kullanılıp kullanılmayacağını belirler. Bu, Microservis mimaride servislerin iletişimi için doğrudan servisler arası iletişim yerine dışarıdan bir API URL ile erişilmek istenildiğinde kullanılmalıdır. Varsayılan değeri false.

Örnek .env Dosyası

Paketinizi kullanırken gerekli environment değişkenlerini ayarlamak için projenizin kök dizininde bir .env dosyası oluşturabilirsiniz:

API_URL=https://api.example.com
DEFAULT_LANGUAGE=en
USE_API_URL=true

Bu environment değişkenlerini kullanarak nextemos paketinizin davranışını özelleştirebilirsiniz.